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
A Timeout is used to call a function at a point in the future. More...
#include <Timeout.h>
Inherits mbed::Ticker.
Public Member Functions | |
| void | attach (Callback< void()> func, float t) |
| Attach a function to be called by the Ticker, specifiying the interval in seconds. | |
| template<typename T , typename M > | |
| void | attach (T *obj, M method, float t) |
| Attach a member function to be called by the Ticker, specifiying the interval in seconds. | |
| void | attach (Callback< void()> func, float t) |
| Attach a function to be called by the Ticker, specifiying the interval in seconds. | |
| template<typename T , typename M > | |
| void | attach (T *obj, M method, float t) |
| Attach a member function to be called by the Ticker, specifiying the interval in seconds. | |
| void | attach_us (Callback< void()> func, timestamp_t t) |
| Attach a function to be called by the Ticker, specifiying the interval in micro-seconds. | |
| template<typename T , typename M > | |
| void | attach_us (T *obj, M method, timestamp_t t) |
| Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds. | |
| void | attach_us (Callback< void()> func, timestamp_t t) |
| Attach a function to be called by the Ticker, specifiying the interval in micro-seconds. | |
| template<typename T , typename M > | |
| void | attach_us (T *obj, M method, timestamp_t t) |
| Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds. | |
| void | detach () |
| Detach the function. | |
| void | detach () |
| Detach the function. | |
Static Public Member Functions | |
| static void | irq (uint32_t id) |
| The handler registered with the underlying timer interrupt. | |
Protected Attributes | |
| timestamp_t | _delay |
| Time delay (in microseconds) for re-setting the multi-shot callback. | |
| Callback< void()> | _function |
| Callback. | |
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.
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 53 of file Timeout.h.
Member Function Documentation
| void attach | ( | Callback< void()> | func, |
| float | t | ||
| ) | [inherited] |
Attach a function to be called by the Ticker, specifiying the interval in seconds.
- Parameters:
-
func pointer to the function to be called t the time between calls in seconds
Definition at line 74 of file mbed-dev/api/Ticker.h.
| void attach | ( | Callback< void()> | func, |
| float | t | ||
| ) | [inherited] |
Attach a function to be called by the Ticker, specifiying the interval in seconds.
- Parameters:
-
func pointer to the function to be called t the time between calls in seconds
Definition at line 74 of file usb_cdc/mbed-dev/api/Ticker.h.
| void attach | ( | T * | obj, |
| M | method, | ||
| float | t | ||
| ) | [inherited] |
Attach a member function to be called by the Ticker, specifiying 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
Definition at line 85 of file usb_cdc/mbed-dev/api/Ticker.h.
| void attach | ( | T * | obj, |
| M | method, | ||
| float | t | ||
| ) | [inherited] |
Attach a member function to be called by the Ticker, specifiying 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
Definition at line 85 of file mbed-dev/api/Ticker.h.
| void attach_us | ( | Callback< void()> | func, |
| timestamp_t | t | ||
| ) | [inherited] |
Attach a function to be called by the Ticker, specifiying the interval in micro-seconds.
- Parameters:
-
fptr pointer to the function to be called t the time between calls in micro-seconds
Definition at line 94 of file usb_cdc/mbed-dev/api/Ticker.h.
| void attach_us | ( | T * | obj, |
| M | method, | ||
| timestamp_t | t | ||
| ) | [inherited] |
Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds.
- Parameters:
-
tptr pointer to the object to call the member function on mptr pointer to the member function to be called t the time between calls in micro-seconds
Definition at line 106 of file usb_cdc/mbed-dev/api/Ticker.h.
| void attach_us | ( | Callback< void()> | func, |
| timestamp_t | t | ||
| ) | [inherited] |
Attach a function to be called by the Ticker, specifiying the interval in micro-seconds.
- Parameters:
-
fptr pointer to the function to be called t the time between calls in micro-seconds
Definition at line 94 of file mbed-dev/api/Ticker.h.
| void attach_us | ( | T * | obj, |
| M | method, | ||
| timestamp_t | t | ||
| ) | [inherited] |
Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds.
- Parameters:
-
tptr pointer to the object to call the member function on mptr pointer to the member function to be called t the time between calls in micro-seconds
Definition at line 106 of file mbed-dev/api/Ticker.h.
| void detach | ( | ) | [inherited] |
Detach the function.
Definition at line 25 of file Ticker.cpp.
| void detach | ( | ) | [inherited] |
Detach the function.
| void irq | ( | uint32_t | id ) | [static, inherited] |
The handler registered with the underlying timer interrupt.
Definition at line 33 of file TimerEvent.cpp.
Field Documentation
timestamp_t _delay [protected, inherited] |
Time delay (in microseconds) for re-setting the multi-shot callback.
Definition at line 123 of file mbed-dev/api/Ticker.h.
Callback< void()> _function [protected, inherited] |
Callback.
Definition at line 124 of file mbed-dev/api/Ticker.h.
Generated on Tue Jul 12 2022 22:19:22 by
1.7.2