Low Power Timout. More...

#include <LowPowerTimeout.h>

Inheritance diagram for LowPowerTimeout:

Public Types
using	clock = LowPowerClock
	Clock to use with attach_absolute, guaranteeing running only while attached or manually locked. More...

using	steady_clock = LowPowerClock
	Clock to use with attach_absolute, running always. More...

Public Member Functions
LowPowerClock::time_point	scheduled_time () const

template<class F >
void	attach_absolute (F &&func, LowPowerClock::time_point abs_time)
	Attach a function to be called by the Timeout, specifying the absolute time. More...

std::chrono::microseconds	remaining_time () const
	Return time remaining until callback. More...

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...

void	attach (Callback< void()> func, std::chrono::microseconds t)
	Attach a function to be called by the Ticker, specifying the interval in microseconds. 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...

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

Detailed Description

Low Power Timout.

Note: Synchronization level: Interrupt safe

Definition at line 38 of file LowPowerTimeout.h.

Member Typedef Documentation

using clock = LowPowerClock

Clock to use with attach_absolute, guaranteeing running only while attached or manually locked.

Definition at line 43 of file LowPowerTimeout.h.

using steady_clock = LowPowerClock

Clock to use with attach_absolute, running always.

Definition at line 46 of file LowPowerTimeout.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

Deprecated:: Pass a chrono duration, not a float second count. For example use 10ms rather than 0.01f.

Definition at line 92 of file Ticker.h.

void attach	(	Callback< void()>	func,
		std::chrono::microseconds	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_absolute	(	F &&	func,
		LowPowerClock::time_point	abs_time
	)

Attach a function to be called by the Timeout, specifying the absolute time.

Parameters

func	pointer to the function to be called
abs_time	the absolute time for the call, referenced to LowPowerClock

Note: setting abs_time to a time in the past means the event will be scheduled immediately resulting in an instant call to the function.

Definition at line 64 of file LowPowerTimeout.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.

Deprecated:: Pass a chrono duration, not an integer microsecond count. For example use 10ms rather than 10000.

void detach ( )

inherited

Detach the function.

std::chrono::microseconds remaining_time ( ) const

inherited

Return time remaining until callback.

Returns: time remaining until callback is due

Note: if the callback is overdue, or has already run, the returned value will be negative

Definition at line 68 of file Timeout.h.

LowPowerClock::time_point scheduled_time ( ) const

Definition at line 49 of file LowPowerTimeout.h.

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation

Important Information for this Arm website