Juan Salazar / mbed

test

Dependents:   robotic_fish_7

Timeout.h@0:44931ff4a3ed, 2020-01-14 (annotated)

Committer:
juansal12
Date:
Tue Jan 14 19:14:29 2020 +0000
Revision:
0:44931ff4a3ed
Sofi 7 code;

Who changed what in which revision?

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