mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

drivers/Timeout.h@184:08ed48f1de7f, 2018-04-19 (annotated)

Committer:
AnnaBridge
Date:
Thu Apr 19 17:12:19 2018 +0100
Revision:
184:08ed48f1de7f
Parent:
174:b96e65c34a4d
Child:
188:bcfe06ba3d64
mbed-dev library. Release version 161

Who changed what in which revision?

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