Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/mbed-dev-bin/Timeout.h@0:b9164b348919, 2016-10-17 (annotated)

Committer:
MrBedfordVan
Date:
Mon Oct 17 12:41:20 2016 +0000
Revision:
0:b9164b348919
Official Sheffield ARMBand Micro:bit program

Who changed what in which revision?

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