Timeout.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #ifndef MBED_TIMEOUT_H
00017 #define MBED_TIMEOUT_H
00018 
00019 #include "Ticker.h"
00020 
00021 namespace mbed {
00022 
00023 /** A Timeout is used to call a function at a point in the future
00024  *
00025  * You can use as many seperate Timeout objects as you require.
00026  *
00027  * @Note Synchronization level: Interrupt safe
00028  *
00029  * Example:
00030  * @code
00031  * // Blink until timeout.
00032  *
00033  * #include "mbed.h"
00034  *
00035  * Timeout timeout;
00036  * DigitalOut led(LED1);
00037  *
00038  * int on = 1;
00039  *
00040  * void attimeout() {
00041  *     on = 0;
00042  * }
00043  *
00044  * int main() {
00045  *     timeout.attach(&attimeout, 5);
00046  *     while(on) {
00047  *         led = !led;
00048  *         wait(0.2);
00049  *     }
00050  * }
00051  * @endcode
00052  */
00053 class Timeout : public Ticker {
00054 
00055 protected:
00056     virtual void handler();
00057 };
00058 
00059 } // namespace mbed
00060 
00061 #endif
00062