John Karatka / mbed

mbed

Fork of mbed-dev by mbed official

drivers/Timeout.h@168:9672193075cf, 2017-07-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Jul 06 15:42:05 2017 +0100
Revision:
168:9672193075cf
Parent:
167:e84263d55307
Child:
175:b96e65c34a4d
This updates the lib to the mbed lib v 146

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"
AnnaBridge 168:9672193075cf 20 #include "platform/NonCopyable.h"
<> 149:156823d33999 21
<> 149:156823d33999 22 namespace mbed {
<> 149:156823d33999 23 /** \addtogroup drivers */
<> 149:156823d33999 24
<> 149:156823d33999 25 /** A Timeout is used to call a function at a point in the future
<> 149:156823d33999 26 *
<> 149:156823d33999 27 * You can use as many seperate Timeout objects as you require.
<> 149:156823d33999 28 *
AnnaBridge 167:e84263d55307 29 * @note Synchronization level: Interrupt safe
<> 149:156823d33999 30 *
<> 149:156823d33999 31 * Example:
<> 149:156823d33999 32 * @code
<> 149:156823d33999 33 * // Blink until timeout.
<> 149:156823d33999 34 *
<> 149:156823d33999 35 * #include "mbed.h"
<> 149:156823d33999 36 *
<> 149:156823d33999 37 * Timeout timeout;
<> 149:156823d33999 38 * DigitalOut led(LED1);
<> 149:156823d33999 39 *
<> 149:156823d33999 40 * int on = 1;
<> 149:156823d33999 41 *
<> 149:156823d33999 42 * void attimeout() {
<> 149:156823d33999 43 * on = 0;
<> 149:156823d33999 44 * }
<> 149:156823d33999 45 *
<> 149:156823d33999 46 * int main() {
<> 149:156823d33999 47 * timeout.attach(&attimeout, 5);
<> 149:156823d33999 48 * while(on) {
<> 149:156823d33999 49 * led = !led;
<> 149:156823d33999 50 * wait(0.2);
<> 149:156823d33999 51 * }
<> 149:156823d33999 52 * }
<> 149:156823d33999 53 * @endcode
AnnaBridge 167:e84263d55307 54 * @ingroup drivers
<> 149:156823d33999 55 */
AnnaBridge 168:9672193075cf 56 class Timeout : public Ticker, private NonCopyable<Timeout> {
<> 149:156823d33999 57
<> 149:156823d33999 58 protected:
<> 149:156823d33999 59 virtual void handler();
<> 149:156823d33999 60 };
<> 149:156823d33999 61
<> 149:156823d33999 62 } // namespace mbed
<> 149:156823d33999 63
<> 149:156823d33999 64 #endif