m2mtimerobserver.h

00001 /*
00002  * Copyright (c) 2015 ARM Limited. All rights reserved.
00003  * SPDX-License-Identifier: Apache-2.0
00004  * Licensed under the Apache License, Version 2.0 (the License); you may
00005  * not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  * http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
00012  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #ifndef M2M_TIMER_OBSERVER_H
00017 #define M2M_TIMER_OBSERVER_H
00018 
00019 /*! \file m2mtimerobserver.h
00020  *  \brief M2MTimerObserver.
00021  *  Observer class for indicating the timer expiry to the parent class.
00022  */
00023 class M2MTimerObserver
00024 {
00025 public:
00026     /**
00027       * \enum Defines the types of timer
00028       * that can be created for mbed Client.
00029       */
00030     typedef enum {
00031         Notdefined,
00032         Registration,
00033         NsdlExecution,
00034         PMinTimer,
00035         PMaxTimer,
00036         Dtls,
00037         QueueSleep,
00038         RetryTimer,
00039         BootstrapFlowTimer,
00040         RegistrationFlowTimer
00041     }Type;
00042 
00043     /**
00044     * \brief Indicates that the timer has expired.
00045     * \param type The type of the timer that has expired.
00046     */
00047     virtual void timer_expired(M2MTimerObserver::Type type =
00048                                M2MTimerObserver::Notdefined) = 0;
00049 };
00050 
00051 #endif // M2M_TIMER_OBSERVER_H