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 "hal/ticker_api.h"
00020 #include "hal/us_ticker_api.h"
00021 
00022 namespace mbed {
00023 /** \addtogroup drivers */
00024 
00025 /** Base abstraction for timer interrupts
00026  *
00027  * @note Synchronization level: Interrupt safe
00028  * @ingroup drivers
00029  */
00030 class TimerEvent {
00031 public:
00032     TimerEvent();
00033     TimerEvent(const ticker_data_t *data);
00034 
00035     /** The handler registered with the underlying timer interrupt
00036      */
00037     static void irq(uint32_t id);
00038 
00039     /** Destruction removes it...
00040      */
00041     virtual ~TimerEvent();
00042 
00043 protected:
00044     // The handler called to service the timer event of the derived class
00045     virtual void handler() = 0;
00046 
00047     // insert relative timestamp in to linked list
00048     void insert(timestamp_t timestamp);
00049 
00050     // insert absolute timestamp into linked list
00051     void insert_absolute(us_timestamp_t timestamp);
00052 
00053     // remove from linked list, if in it
00054     void remove();
00055 
00056     ticker_event_t event;
00057 
00058     const ticker_data_t *_ticker_data;
00059 };
00060 
00061 } // namespace mbed
00062 
00063 #endif
00064