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.
Timeout Class Reference
[Drivers]
A Timeout is used to call a function at a point in the future. More...
#include <Timeout.h>
Inherits mbed::Ticker, and NonCopyable< Timeout >.
Public Member Functions | |
| void | attach (Callback< void()> func, float t) |
| Attach a function to be called by the Ticker, specifying the interval in seconds. | |
| template<typename T , typename M > | |
| MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method), t).") void attach(T *obj | |
| Attach a member function to be called by the Ticker, specifying the interval in seconds. | |
Static Public Member Functions | |
| static void | irq (uint32_t id) |
| The handler registered with the underlying timer interrupt. | |
Protected Attributes | |
| us_timestamp_t | _delay |
| Time delay (in microseconds) for re-setting the multi-shot callback. | |
| Callback< void()> | _function |
| Callback. | |
| bool | _lock_deepsleep |
| Flag which indicates if deep-sleep should be disabled. | |
Detailed Description
A Timeout is used to call a function at a point in the future.
You can use as many seperate Timeout objects as you require.
- Note:
- Synchronization level: Interrupt safe
Example:
// Blink until timeout. #include "mbed.h" Timeout timeout; DigitalOut led(LED1); int on = 1; void attimeout() { on = 0; } int main() { timeout.attach(&attimeout, 5); while(on) { led = !led; wait(0.2); } }
Definition at line 57 of file Timeout.h.
Member Function Documentation
| void attach | ( | Callback< void()> | func, |
| float | t | ||
| ) | [inherited] |
| void irq | ( | uint32_t | id ) | [static, inherited] |
The handler registered with the underlying timer interrupt.
- Parameters:
-
id Timer Event ID
Definition at line 33 of file TimerEvent.cpp.
| MBED_DEPRECATED_SINCE | ( | "mbed-os-5.1" | , |
| "The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method), t)." | |||
| ) | [inherited] |
Attach a member function to be called by the Ticker, specifying the interval in seconds.
- Parameters:
-
obj pointer to the object to call the member function on method pointer to the member function to be called t the time between calls in seconds
Field Documentation
us_timestamp_t _delay [protected, inherited] |
Callback<void()> _function [protected, inherited] |
bool _lock_deepsleep [protected, inherited] |
Generated on Tue Jul 12 2022 20:03:34 by
1.7.2