BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/drivers/Timeout.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

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