BA / Mbed OS BaBoRo1

Erste version der Software für der Prototyp

mbed-os/drivers/Timeout.h@4:75df35ef4fb6, 2018-03-30 (annotated)

Committer:
borlanic
Date:
Fri Mar 30 14:07:05 2018 +0000
Revision:
4:75df35ef4fb6
Parent:
0:380207fcb5c1 
commentar

Who changed what in which revision?

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