A Timeout is used to call a function at a point in the future. More...

#include <Timeout.h>

Inheritance diagram for Timeout:

Public Member Functions
template<typename F >
MBED_FORCEINLINE void	attach (F &&func, float t)
	Attach a function to be called by the Ticker, specifying the interval in seconds. More...

template<typename T , typename M >
void	attach (T *obj, M method, float t)
	Attach a member function to be called by the Ticker, specifying the interval in seconds. More...

void	attach_us (Callback< void()> func, us_timestamp_t t)
	Attach a function to be called by the Ticker, specifying the interval in microseconds. More...

template<typename T , typename M >
void	attach_us (T *obj, M method, us_timestamp_t t)
	Attach a member function to be called by the Ticker, specifying the interval in microseconds. More...

void	detach ()
	Detach the function. More...

Static Public Member Functions
static void	irq (uint32_t id)
	The handler registered with the underlying timer interrupt. More...

Detailed Description

A Timeout is used to call a function at a point in the future.

You can use as many separate 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 60 of file Timeout.h.

Member Function Documentation

MBED_FORCEINLINE void attach	(	F &&	func,
		float	t
	)

inherited

Attach a function to be called by the Ticker, specifying the interval in seconds.

The method forwards its arguments to attach_us() rather than copying them which may not be trivial depending on the callback copied. The function is forcibly inlined to not use floating-point operations. This is possible given attach_us() expects an integer value for the callback interval.

Parameters

func	pointer to the function to be called
t	the time between calls in seconds

Definition at line 91 of file Ticker.h.

void attach	(	T *	obj,
		M	method,
		float	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

Deprecated:: The attach function does not support cv-qualifiers. Replaced by attach(callback(obj, method), t).

Definition at line 109 of file Ticker.h.

void attach_us	(	Callback< void()>	func,
		us_timestamp_t	t
	)

inherited

Attach a function to be called by the Ticker, specifying the interval in microseconds.

Parameters

func	pointer to the function to be called
t	the time between calls in micro-seconds

Note: setting t to a value shorter than it takes to process the ticker callback causes the system to hang. Ticker callback is called constantly with no time for threads scheduling.

void attach_us	(	T *	obj,
		M	method,
		us_timestamp_t	t
	)

inherited

Attach a member function to be called by the Ticker, specifying the interval in microseconds.

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 microseconds

Deprecated:: The attach_us function does not support cv-qualifiers. Replaced by attach_us(callback(obj, method), t).

Definition at line 139 of file Ticker.h.

void detach ( )

inherited

Detach the function.

static void irq ( uint32_t id )

staticinherited

The handler registered with the underlying timer interrupt.

Parameters

id	Timer Event ID

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

Important Information for this Arm website