tool/mbed/mbed-sdk/libraries/mbed/api/TimerEvent.h

   1 /* mbed Microcontroller Library
   2  * Copyright (c) 2006-2013 ARM Limited
   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 #ifndef MBED_TIMEREVENT_H
  17 #define MBED_TIMEREVENT_H
  18
  19 #include "us_ticker_api.h"
  20
  21 namespace mbed {
  22
  23 /** Base abstraction for timer interrupts
  24 */
  25 class TimerEvent {
  26 public:
  27     TimerEvent();
  28
  29     /** The handler registered with the underlying timer interrupt
  30      */
  31     static void irq(uint32_t id);
  32
  33     /** Destruction removes it...
  34      */
  35     virtual ~TimerEvent();
  36
  37 protected:
  38     // The handler called to service the timer event of the derived class
  39     virtual void handler() = 0;
  40
  41     // insert in to linked list
  42     void insert(timestamp_t timestamp);
  43
  44     // remove from linked list, if in it
  45     void remove();
  46
  47     ticker_event_t event;
  48 };
  49
  50 } // namespace mbed
  51
  52 #endif