R L / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/Timeout.h@636:21ce76d41a4f, 2016-02-21 (annotated)

Committer:
rllamado
Date:
Sun Feb 21 07:27:08 2016 +0000
Revision:
636:21ce76d41a4f
Parent:
13:0645d8841f51 
something

Who changed what in which revision?

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