Bob Seque / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/TimerEvent.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 0:9b334a45a8ff 1 /* mbed Microcontroller Library
bogdanm 0:9b334a45a8ff 2 * Copyright (c) 2006-2013 ARM Limited
bogdanm 0:9b334a45a8ff 3 *
bogdanm 0:9b334a45a8ff 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 0:9b334a45a8ff 5 * you may not use this file except in compliance with the License.
bogdanm 0:9b334a45a8ff 6 * You may obtain a copy of the License at
bogdanm 0:9b334a45a8ff 7 *
bogdanm 0:9b334a45a8ff 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 0:9b334a45a8ff 9 *
bogdanm 0:9b334a45a8ff 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 0:9b334a45a8ff 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 0:9b334a45a8ff 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 0:9b334a45a8ff 13 * See the License for the specific language governing permissions and
bogdanm 0:9b334a45a8ff 14 * limitations under the License.
bogdanm 0:9b334a45a8ff 15 */
bogdanm 0:9b334a45a8ff 16 #ifndef MBED_TIMEREVENT_H
bogdanm 0:9b334a45a8ff 17 #define MBED_TIMEREVENT_H
bogdanm 0:9b334a45a8ff 18
bogdanm 0:9b334a45a8ff 19 #include "ticker_api.h"
bogdanm 0:9b334a45a8ff 20 #include "us_ticker_api.h"
bogdanm 0:9b334a45a8ff 21
bogdanm 0:9b334a45a8ff 22 namespace mbed {
bogdanm 0:9b334a45a8ff 23
bogdanm 0:9b334a45a8ff 24 /** Base abstraction for timer interrupts
bogdanm 0:9b334a45a8ff 25 */
bogdanm 0:9b334a45a8ff 26 class TimerEvent {
bogdanm 0:9b334a45a8ff 27 public:
bogdanm 0:9b334a45a8ff 28 TimerEvent();
bogdanm 0:9b334a45a8ff 29 TimerEvent(const ticker_data_t *data);
bogdanm 0:9b334a45a8ff 30
bogdanm 0:9b334a45a8ff 31 /** The handler registered with the underlying timer interrupt
bogdanm 0:9b334a45a8ff 32 */
bogdanm 0:9b334a45a8ff 33 static void irq(uint32_t id);
bogdanm 0:9b334a45a8ff 34
bogdanm 0:9b334a45a8ff 35 /** Destruction removes it...
bogdanm 0:9b334a45a8ff 36 */
bogdanm 0:9b334a45a8ff 37 virtual ~TimerEvent();
bogdanm 0:9b334a45a8ff 38
bogdanm 0:9b334a45a8ff 39 protected:
bogdanm 0:9b334a45a8ff 40 // The handler called to service the timer event of the derived class
bogdanm 0:9b334a45a8ff 41 virtual void handler() = 0;
bogdanm 0:9b334a45a8ff 42
bogdanm 0:9b334a45a8ff 43 // insert in to linked list
bogdanm 0:9b334a45a8ff 44 void insert(timestamp_t timestamp);
bogdanm 0:9b334a45a8ff 45
bogdanm 0:9b334a45a8ff 46 // remove from linked list, if in it
bogdanm 0:9b334a45a8ff 47 void remove();
bogdanm 0:9b334a45a8ff 48
bogdanm 0:9b334a45a8ff 49 ticker_event_t event;
bogdanm 0:9b334a45a8ff 50
bogdanm 0:9b334a45a8ff 51 const ticker_data_t *_ticker_data;
bogdanm 0:9b334a45a8ff 52 };
bogdanm 0:9b334a45a8ff 53
bogdanm 0:9b334a45a8ff 54 } // namespace mbed
bogdanm 0:9b334a45a8ff 55
bogdanm 0:9b334a45a8ff 56 #endif