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@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

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