Vladimir Vana / mbed

pro vyuku PSS v Jecne

Timeout.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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