TUKS MCU Introductory course / TUKS-COURSE-TIMER

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.

mbed-dev/drivers/Timeout.h@1:d0dfbce63a89, 2017-02-24 (annotated)

Committer:
elmot
Date:
Fri Feb 24 21:13:56 2017 +0000
Revision:
1:d0dfbce63a89
Ready-to-copy

Who changed what in which revision?

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