Toyomasa Watarai / Mbed OS armcc_info

Describes predefine macros for mbed online compiler (armcc)

mbed/drivers/Timeout.h@6:40e873bbc5f7, 2017-03-16 (annotated)

Committer:
MACRUM
Date:
Thu Mar 16 21:58:09 2017 +0900
Revision:
6:40e873bbc5f7
Add licence header info

Who changed what in which revision?

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