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@169:a7c7b631e539, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 15:38:59 2018 +0100
Revision:
169:a7c7b631e539
Parent:
165:d1b4690b3f8b
Child:
171:3a7713b1edbc
mbed library. Release version 162

Who changed what in which revision?

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