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