Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

Timeout.h@9:663789d7729f, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 09:41:56 2013 +0000
Revision:
9:663789d7729f
Parent:
8:c14af7958ef5 
Update mbed-KL25Z to latest build

Who changed what in which revision?

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