Bob Seque / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/Timeout.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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