Timeout.h

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