Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

mbed-os/drivers/Timeout.h@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:
marcozecchini
Date:
Sat Feb 23 12:13:36 2019 +0000
Revision:
0:9fca2b23d0ba
final commit

Who changed what in which revision?

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