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 "us_ticker_api.h"
00020 
00021 namespace mbed {
00022 
00023 /** Base abstraction for timer interrupts
00024 */
00025 class TimerEvent {
00026 public:
00027     TimerEvent();
00028 
00029     /** The handler registered with the underlying timer interrupt
00030      */
00031     static void irq(uint32_t id);
00032 
00033     /** Destruction removes it...
00034      */
00035     virtual ~TimerEvent();
00036 
00037 protected:
00038     // The handler called to service the timer event of the derived class
00039     virtual void handler() = 0;
00040 
00041     // insert in to linked list
00042     void insert(timestamp_t timestamp);
00043 
00044     // remove from linked list, if in it
00045     void remove();
00046 
00047     ticker_event_t event;
00048 };
00049 
00050 } // namespace mbed
00051 
00052 #endif