ju Lei / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

Timeout.h@64:75c1708b266b, 2013-07-05 (annotated)

Committer:
ldyz
Date:
Fri Jul 05 13:16:13 2013 +0000
Revision:
64:75c1708b266b
Parent:
59:0883845fe643 
test

Who changed what in which revision?

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