include/timer_listener_iface.h

   1 /*
   2  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __CONTEXT_TIMER_LISTENER_INTERFACE_H__
  18 #define __CONTEXT_TIMER_LISTENER_INTERFACE_H__
  19
  20 namespace ctx {
  21
  22         class timer_listener_iface {
  23                 public:
  24                         virtual ~timer_listener_iface() {}
  25
  26                         /**
  27                          * @brief               Called when a timer is expired.
  28                          * @param[in]   timer_id        The expired timers' ID
  29                          * @return              @c true, if the timer needs to be repeated.@n
  30                          *                              @c false, if the timer does not need to be repeated anymore.
  31                          */
  32                         virtual bool on_timer_expired(int timer_id, void* user_data) = 0;
  33         };
  34
  35 }       /* namespace ctx */
  36
  37 #endif  /* End of __CONTEXT_TIMER_LISTENER_INTERFACE_H__ */