John Karatka / mbed

mbed

Fork of mbed-dev by mbed official

drivers/Timeout.h@167:e84263d55307, 2017-06-21 (annotated)

Committer:
AnnaBridge
Date:
Wed Jun 21 17:46:44 2017 +0100
Revision:
167:e84263d55307
Parent:
149:156823d33999
Child:
168:9672193075cf
This updates the lib to the mbed lib v 145

Who changed what in which revision?

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