Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

Timeout.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

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