Morpheus / mbed-hal

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   target-freescale

api/Timeout.h@0:9c59db1fbc9e, 2016-03-23 (annotated)

Committer:
screamer
Date:
Wed Mar 23 21:36:09 2016 +0000
Revision:
0:9c59db1fbc9e
Initial revision

Who changed what in which revision?

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