Bernhard Filzmaier / mbed-src

mbed library sources

Fork of mbed-src by mbed official

cpp/Timeout.h@2:143cac498751, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 11:44:18 2013 +0000
Revision:
2:143cac498751
Parent:
0:fd0d7bdfcdc2 
Update mbed sources to Rev 59

Who changed what in which revision?

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