Thor Hall / mbed-dev_mbed_lib_v125

This fork captures the mbed lib v125 for ease of integration into older projects.

Fork of mbed-dev by mbed official

api/Timeout.h@187:92cbb9eec47b, 2018-07-20 (annotated)

Committer:
apluscw
Date:
Fri Jul 20 21:24:42 2018 +0000
Revision:
187:92cbb9eec47b
Mbed library with source code from mbed lib v125. Posted to ease integration with some older projects.

Who changed what in which revision?

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