jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

Timeout.h@54:71b101360fb9, 2013-01-08 (annotated)

Committer:
emilmont
Date:
Tue Jan 08 12:46:36 2013 +0000
Revision:
54:71b101360fb9
Parent:
44:24d45a770a51
Child:
55:d722ed6a4237
Support "stream as file" use case

Unify binary libraries

Update copyright

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 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
emilmont 44:24d45a770a51 21 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 22 #ifndef MBED_TIMEOUT_H
simon.ford@mbed.co.uk 9:cf0d45ce28a6 23 #define MBED_TIMEOUT_H
simon.ford@mbed.co.uk 9:cf0d45ce28a6 24
simon.ford@mbed.co.uk 9:cf0d45ce28a6 25 #include "Ticker.h"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 26
simon.ford@mbed.co.uk 9:cf0d45ce28a6 27 namespace mbed {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 28
emilmont 43:e2ed12d17f06 29 /** A Timeout is used to call a function at a point in the future
simon.ford@mbed.co.uk 9:cf0d45ce28a6 30 *
emilmont 44:24d45a770a51 31 * You can use as many seperate Timeout objects as you require.
rolf.meyer@arm.com 11:1c1ebd0324fa 32 *
rolf.meyer@arm.com 11:1c1ebd0324fa 33 * Example:
emilmont 43:e2ed12d17f06 34 * @code
emilmont 43:e2ed12d17f06 35 * // Blink until timeout.
emilmont 43:e2ed12d17f06 36 *
emilmont 43:e2ed12d17f06 37 * #include "mbed.h"
emilmont 43:e2ed12d17f06 38 *
emilmont 43:e2ed12d17f06 39 * Timeout timeout;
emilmont 43:e2ed12d17f06 40 * DigitalOut led(LED1);
emilmont 43:e2ed12d17f06 41 *
emilmont 43:e2ed12d17f06 42 * int on = 1;
emilmont 43:e2ed12d17f06 43 *
emilmont 43:e2ed12d17f06 44 * void attimeout() {
emilmont 43:e2ed12d17f06 45 * on = 0;
emilmont 43:e2ed12d17f06 46 * }
emilmont 43:e2ed12d17f06 47 *
emilmont 43:e2ed12d17f06 48 * int main() {
emilmont 43:e2ed12d17f06 49 * timeout.attach(&attimeout, 5);
emilmont 43:e2ed12d17f06 50 * while(on) {
emilmont 43:e2ed12d17f06 51 * led = !led;
emilmont 43:e2ed12d17f06 52 * wait(0.2);
emilmont 43:e2ed12d17f06 53 * }
emilmont 43:e2ed12d17f06 54 * }
emilmont 43:e2ed12d17f06 55 * @endcode
simon.ford@mbed.co.uk 9:cf0d45ce28a6 56 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 57 class Timeout : public Ticker {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 58
simon.ford@mbed.co.uk 9:cf0d45ce28a6 59 protected:
rolf.meyer@arm.com 11:1c1ebd0324fa 60 virtual void handler();
rolf.meyer@arm.com 11:1c1ebd0324fa 61 };
rolf.meyer@arm.com 11:1c1ebd0324fa 62
rolf.meyer@arm.com 11:1c1ebd0324fa 63 } // namespace mbed
simon.ford@mbed.co.uk 9:cf0d45ce28a6 64
simon.ford@mbed.co.uk 9:cf0d45ce28a6 65 #endif