Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

drivers/Timeout.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 /* mbed Microcontroller Library
elessair 0:f269e3021894 2 * Copyright (c) 2006-2013 ARM Limited
elessair 0:f269e3021894 3 *
elessair 0:f269e3021894 4 * Licensed under the Apache License, Version 2.0 (the "License");
elessair 0:f269e3021894 5 * you may not use this file except in compliance with the License.
elessair 0:f269e3021894 6 * You may obtain a copy of the License at
elessair 0:f269e3021894 7 *
elessair 0:f269e3021894 8 * http://www.apache.org/licenses/LICENSE-2.0
elessair 0:f269e3021894 9 *
elessair 0:f269e3021894 10 * Unless required by applicable law or agreed to in writing, software
elessair 0:f269e3021894 11 * distributed under the License is distributed on an "AS IS" BASIS,
elessair 0:f269e3021894 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
elessair 0:f269e3021894 13 * See the License for the specific language governing permissions and
elessair 0:f269e3021894 14 * limitations under the License.
elessair 0:f269e3021894 15 */
elessair 0:f269e3021894 16 #ifndef MBED_TIMEOUT_H
elessair 0:f269e3021894 17 #define MBED_TIMEOUT_H
elessair 0:f269e3021894 18
elessair 0:f269e3021894 19 #include "drivers/Ticker.h"
elessair 0:f269e3021894 20
elessair 0:f269e3021894 21 namespace mbed {
elessair 0:f269e3021894 22 /** \addtogroup drivers */
elessair 0:f269e3021894 23 /** @{*/
elessair 0:f269e3021894 24
elessair 0:f269e3021894 25 /** A Timeout is used to call a function at a point in the future
elessair 0:f269e3021894 26 *
elessair 0:f269e3021894 27 * You can use as many seperate Timeout objects as you require.
elessair 0:f269e3021894 28 *
elessair 0:f269e3021894 29 * @Note Synchronization level: Interrupt safe
elessair 0:f269e3021894 30 *
elessair 0:f269e3021894 31 * Example:
elessair 0:f269e3021894 32 * @code
elessair 0:f269e3021894 33 * // Blink until timeout.
elessair 0:f269e3021894 34 *
elessair 0:f269e3021894 35 * #include "mbed.h"
elessair 0:f269e3021894 36 *
elessair 0:f269e3021894 37 * Timeout timeout;
elessair 0:f269e3021894 38 * DigitalOut led(LED1);
elessair 0:f269e3021894 39 *
elessair 0:f269e3021894 40 * int on = 1;
elessair 0:f269e3021894 41 *
elessair 0:f269e3021894 42 * void attimeout() {
elessair 0:f269e3021894 43 * on = 0;
elessair 0:f269e3021894 44 * }
elessair 0:f269e3021894 45 *
elessair 0:f269e3021894 46 * int main() {
elessair 0:f269e3021894 47 * timeout.attach(&attimeout, 5);
elessair 0:f269e3021894 48 * while(on) {
elessair 0:f269e3021894 49 * led = !led;
elessair 0:f269e3021894 50 * wait(0.2);
elessair 0:f269e3021894 51 * }
elessair 0:f269e3021894 52 * }
elessair 0:f269e3021894 53 * @endcode
elessair 0:f269e3021894 54 */
elessair 0:f269e3021894 55 class Timeout : public Ticker {
elessair 0:f269e3021894 56
elessair 0:f269e3021894 57 protected:
elessair 0:f269e3021894 58 virtual void handler();
elessair 0:f269e3021894 59 };
elessair 0:f269e3021894 60
elessair 0:f269e3021894 61 } // namespace mbed
elessair 0:f269e3021894 62
elessair 0:f269e3021894 63 #endif
elessair 0:f269e3021894 64
elessair 0:f269e3021894 65 /** @}*/