modtronix H / mbed_nz32sc151

mbed library for NZ32-SC151

api/Timeout.h@16:076cbe3e55be, 2016-08-15 (annotated)

Committer:
modtronix-com
Date:
Mon Aug 15 14:57:08 2016 +1000
Revision:
16:076cbe3e55be
Parent:
1:71204b8406f2 
Added tag v1.0 for changeset 8123a070ade6

Who changed what in which revision?

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