Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

api/Timeout.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

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