mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/Timeout.h@147:a97add6d7e64, 2017-07-19 (annotated)

Committer:
Kojto
Date:
Wed Jul 19 16:46:19 2017 +0100
Revision:
147:a97add6d7e64
Parent:
146:22da6e220af6
Child:
152:235179ab3f27
Release 147 of the mbed library.

Who changed what in which revision?

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