Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/Timeout.h@0:ba7650f404af, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 02:26:59 2015 +0000
Revision:
0:ba7650f404af
Reduced HSE_STARTUP_TIMEOUT to 500 ms, fixed some compiler warnings

Who changed what in which revision?

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