initial

Dependencies:   mbed

Committer:
yihui
Date:
Mon Jan 11 02:32:24 2016 +0000
Revision:
0:638edba3adf6
initial

Who changed what in which revision?

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