Kev Mann / mbed-dev-OS5_10_4

RTC auf true

drivers/Timeout.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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