mbed official / mbed

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.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

drivers/Timeout.h@152:235179ab3f27, 2017-10-02 (annotated)

Committer:
AnnaBridge
Date:
Mon Oct 02 15:20:36 2017 +0100
Revision:
152:235179ab3f27
Parent:
146:22da6e220af6 
Release 152 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"
AnnaBridge 152:235179ab3f27 21 #include "platform/mbed_sleep.h"
<> 128:9bcdf88f62b0 22
<> 128:9bcdf88f62b0 23 namespace mbed {
<> 128:9bcdf88f62b0 24 /** \addtogroup drivers */
<> 128:9bcdf88f62b0 25
<> 128:9bcdf88f62b0 26 /** A Timeout is used to call a function at a point in the future
<> 128:9bcdf88f62b0 27 *
<> 128:9bcdf88f62b0 28 * You can use as many seperate Timeout objects as you require.
<> 128:9bcdf88f62b0 29 *
AnnaBridge 145:64910690c574 30 * @note Synchronization level: Interrupt safe
<> 128:9bcdf88f62b0 31 *
<> 128:9bcdf88f62b0 32 * Example:
<> 128:9bcdf88f62b0 33 * @code
<> 128:9bcdf88f62b0 34 * // Blink until timeout.
<> 128:9bcdf88f62b0 35 *
<> 128:9bcdf88f62b0 36 * #include "mbed.h"
<> 128:9bcdf88f62b0 37 *
<> 128:9bcdf88f62b0 38 * Timeout timeout;
<> 128:9bcdf88f62b0 39 * DigitalOut led(LED1);
<> 128:9bcdf88f62b0 40 *
<> 128:9bcdf88f62b0 41 * int on = 1;
<> 128:9bcdf88f62b0 42 *
<> 128:9bcdf88f62b0 43 * void attimeout() {
<> 128:9bcdf88f62b0 44 * on = 0;
<> 128:9bcdf88f62b0 45 * }
<> 128:9bcdf88f62b0 46 *
<> 128:9bcdf88f62b0 47 * int main() {
<> 128:9bcdf88f62b0 48 * timeout.attach(&attimeout, 5);
<> 128:9bcdf88f62b0 49 * while(on) {
<> 128:9bcdf88f62b0 50 * led = !led;
<> 128:9bcdf88f62b0 51 * wait(0.2);
<> 128:9bcdf88f62b0 52 * }
<> 128:9bcdf88f62b0 53 * }
<> 128:9bcdf88f62b0 54 * @endcode
AnnaBridge 145:64910690c574 55 * @ingroup drivers
<> 128:9bcdf88f62b0 56 */
AnnaBridge 146:22da6e220af6 57 class Timeout : public Ticker, private NonCopyable<Timeout> {
<> 128:9bcdf88f62b0 58
<> 128:9bcdf88f62b0 59 protected:
<> 128:9bcdf88f62b0 60 virtual void handler();
<> 128:9bcdf88f62b0 61 };
<> 128:9bcdf88f62b0 62
<> 128:9bcdf88f62b0 63 } // namespace mbed
<> 128:9bcdf88f62b0 64
<> 128:9bcdf88f62b0 65 #endif