Jhon Plantikow / mbed

.

Dependents:   RTC

Timeout.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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