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