Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

drivers/Timeout.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

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