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