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