Timeout.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 #ifndef MBED_TIMEOUT_H
00023 #define MBED_TIMEOUT_H
00024 
00025 #include "Ticker.h"
00026 
00027 namespace mbed {
00028 
00029 /** A Timeout is used to call a function at a point in the future
00030  *
00031  * You can use as many seperate Timeout objects as you require.
00032  *
00033  * Example:
00034  * @code
00035  * // Blink until timeout.
00036  *
00037  * #include "mbed.h"
00038  *
00039  * Timeout timeout;
00040  * DigitalOut led(LED1);
00041  *
00042  * int on = 1;
00043  *
00044  * void attimeout() {
00045  *     on = 0;
00046  * }
00047  *
00048  * int main() {
00049  *     timeout.attach(&attimeout, 5);
00050  *     while(on) {
00051  *         led = !led;
00052  *         wait(0.2);
00053  *     }
00054  * }
00055  * @endcode
00056  */
00057 class Timeout : public Ticker {
00058 
00059 protected:
00060     virtual void handler();
00061 };
00062 
00063 } // namespace mbed
00064 
00065 #endif
00066