TimerEvent.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may 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,
00012  * WITHOUT 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 MBED_TIMEREVENT_H
00017 #define MBED_TIMEREVENT_H
00018 
00019 #include "ticker_api.h"
00020 #include "us_ticker_api.h"
00021 
00022 namespace mbed {
00023 
00024 /** Base abstraction for timer interrupts
00025  *
00026  * @Note Synchronization level: Interrupt safe
00027  */
00028 class TimerEvent {
00029 public:
00030     TimerEvent();
00031     TimerEvent(const ticker_data_t *data);
00032 
00033     /** The handler registered with the underlying timer interrupt
00034      */
00035     static void irq(uint32_t id);
00036 
00037     /** Destruction removes it...
00038      */
00039     virtual ~TimerEvent();
00040 
00041 protected:
00042     // The handler called to service the timer event of the derived class
00043     virtual void handler() = 0;
00044 
00045     // insert in to linked list
00046     void insert(timestamp_t timestamp);
00047 
00048     // remove from linked list, if in it
00049     void remove();
00050 
00051     ticker_event_t event;
00052 
00053     const ticker_data_t *_ticker_data;
00054 };
00055 
00056 } // namespace mbed
00057 
00058 #endif