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 "drivers/Ticker.h"
00020 
00021 namespace mbed {
00022 /** \addtogroup drivers */
00023 
00024 /** A Timeout is used to call a function at a point in the future
00025  *
00026  * You can use as many seperate Timeout objects as you require.
00027  *
00028  * @note Synchronization level: Interrupt safe
00029  *
00030  * Example:
00031  * @code
00032  * // Blink until timeout.
00033  *
00034  * #include "mbed.h"
00035  *
00036  * Timeout timeout;
00037  * DigitalOut led(LED1);
00038  *
00039  * int on = 1;
00040  *
00041  * void attimeout() {
00042  *     on = 0;
00043  * }
00044  *
00045  * int main() {
00046  *     timeout.attach(&attimeout, 5);
00047  *     while(on) {
00048  *         led = !led;
00049  *         wait(0.2);
00050  *     }
00051  * }
00052  * @endcode
00053  * @ingroup drivers
00054  */
00055 class Timeout : public Ticker {
00056 
00057 protected:
00058     virtual void handler();
00059 };
00060 
00061 } // namespace mbed
00062 
00063 #endif