Bernhard Filzmaier / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/Timeout.h@10:3bc89ef62ce7, 2013-06-14 (annotated)

Committer:
emilmont
Date:
Fri Jun 14 17:49:17 2013 +0100
Revision:
10:3bc89ef62ce7
Parent:
9:0ce32e54c9a7
Child:
13:0645d8841f51
Unify mbed library sources

Who changed what in which revision?

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