Mateusz Kowalik / Application_danix

,,

Fork of Application by Daniel Sygut

mbed-dev/drivers/Timeout.h@15:2a20c3d2616e, 2018-02-15 (annotated)

Committer:
Zaitsev
Date:
Thu Feb 15 14:29:23 2018 +0000
Revision:
15:2a20c3d2616e
Parent:
10:41552d038a69 
j

Who changed what in which revision?

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