Diff: mbed-client/mbed-client/m2mtimer.h

Revision:

0:a7a43371b306

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed-client/mbed-client/m2mtimer.h	Sun May 14 18:40:18 2017 +0000
@@ -0,0 +1,89 @@
+/*
+ * Copyright (c) 2015 ARM Limited. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ * Licensed under the Apache License, Version 2.0 (the License); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef M2M_TIMER_H
+#define M2M_TIMER_H
+
+#include <stdint.h>
+#include "mbed-client/m2mtimerobserver.h"
+
+class M2MTimerPimpl;
+
+/*! \file m2mtimer.h
+* \brief M2MTimer.
+* Timer class for mbed client.
+*/
+class M2MTimer
+{
+private:
+    // Prevents the use of assignment operator
+    M2MTimer& operator=(const M2MTimer& other);
+
+    // Prevents the use of copy constructor
+    M2MTimer(const M2MTimer& other);
+
+public:
+
+    /**
+    * Constructor.
+    */
+    M2MTimer(M2MTimerObserver& observer);
+
+    /**
+    * Destructor.
+    */
+    ~M2MTimer();
+
+    /**
+    * \brief Starts the timer.
+    * \param interval The timer interval in milliseconds.
+    * \param single_shot Defines whether the timer is ticked once or restarted every time at expiry.
+    */
+    void start_timer(uint64_t interval, M2MTimerObserver::Type type, bool single_shot = true);
+
+    /**
+     * \brief Starts the timer in DTLS manner.
+     * \param intermediate_interval The intermediate interval to use, must be smaller than total (usually 1/4 of total).
+     * \param total_interval The total interval to use; This is the timeout value of a DTLS packet.
+     * \param type The type of the timer.
+     */
+    void start_dtls_timer(uint64_t intermediate_interval, uint64_t total_interval, M2MTimerObserver::Type type = M2MTimerObserver::Dtls);
+
+    /**
+    * \brief Stops the timer.
+    * This cancels the ongoing timer.
+    */
+    void stop_timer();
+
+    /**
+     * \brief Checks if the intermediate interval has passed.
+     * \return True if the interval has passed, else false.
+     */
+    bool is_intermediate_interval_passed();
+
+    /**
+     * \brief Checks if the total interval has passed.
+     * \return True if the interval has passed, else false.
+     */
+    bool is_total_interval_passed();
+
+private:
+
+    M2MTimerObserver&   _observer;
+    M2MTimerPimpl       *_private_impl;
+    friend class Test_M2MTimerImpl_linux;
+};
+
+#endif // M2M_TIMER_H