Steven Wray / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/Timeout.h@144:ef7eb2e8f9f7, 2016-09-02 (annotated)

Committer:
<>
Date:
Fri Sep 02 15:07:44 2016 +0100
Revision:
144:ef7eb2e8f9f7
Parent:
0:9b334a45a8ff 
This updates the lib to the mbed lib v125

Who changed what in which revision?

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