Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

Timeout.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
65:5798e58a58b1 
dgdgr

Who changed what in which revision?

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