mbed library sources
Fork of mbed-src by
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 (void(*fptr)(void), float t) |
Attach a function to be called by the Ticker, specifiying the interval in seconds. | |
template<typename T > | |
void | attach (T *tptr, void(T::*mptr)(void), float t) |
Attach a member function to be called by the Ticker, specifiying the interval in seconds. | |
void | attach_us (void(*fptr)(void), timestamp_t t) |
Attach a function to be called by the Ticker, specifiying the interval in micro-seconds. | |
template<typename T > | |
void | attach_us (T *tptr, void(T::*mptr)(void), timestamp_t t) |
Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds. | |
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. | |
FunctionPointer | _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.
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 51 of file Timeout.h.
Member Function Documentation
void attach | ( | void(*)(void) | fptr, |
float | t | ||
) | [inherited] |
void attach | ( | T * | tptr, |
void(T::*)(void) | mptr, | ||
float | t | ||
) | [inherited] |
void attach_us | ( | void(*)(void) | fptr, |
timestamp_t | t | ||
) | [inherited] |
void attach_us | ( | T * | tptr, |
void(T::*)(void) | mptr, | ||
timestamp_t | t | ||
) | [inherited] |
void detach | ( | ) | [inherited] |
Detach the function.
Definition at line 24 of file Ticker.cpp.
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] |
FunctionPointer _function [protected, inherited] |
Generated on Tue Jul 12 2022 17:14:56 by 1.7.2