Embedded Template Library 1.0
Loading...
Searching...
No Matches
etl::icallback_timer Class Reference

Interface for callback timer. More...

#include <callback_timer.h>

Public Types

typedef etl::delegate< void(void)> callback_type
 

Public Member Functions

etl::timer::id::type register_timer (void(*p_callback_)(), uint32_t period_, bool repeating_)
 Register a timer.
 
etl::timer::id::type register_timer (etl::ifunction< void > &callback_, uint32_t period_, bool repeating_)
 Register a timer.
 
bool unregister_timer (etl::timer::id::type id_)
 Register a timer.
 
void enable (bool state_)
 Enable/disable the timer.
 
bool is_running () const
 Get the enable/disable state.
 
void clear ()
 Clears the timer of data.
 
bool tick (uint32_t count)
 
bool start (etl::timer::id::type id_, bool immediate_=false)
 Starts a timer.
 
bool stop (etl::timer::id::type id_)
 Stops a timer.
 
bool set_period (etl::timer::id::type id_, uint32_t period_)
 Sets a timer's period.
 
bool set_mode (etl::timer::id::type id_, bool repeating_)
 Sets a timer's mode.
 
bool has_active_timer () const
 Check if there is an active timer.
 
uint32_t time_to_next () const
 
bool is_active (etl::timer::id::type id_) const
 

Public Attributes

const uint_least8_t MAX_TIMERS
 

Protected Member Functions

 icallback_timer (callback_timer_data *const timer_array_, const uint_least8_t MAX_TIMERS_)
 Constructor.
 

Detailed Description

Interface for callback timer.

Member Function Documentation

◆ is_active()

bool etl::icallback_timer::is_active ( etl::timer::id::type  id_) const
inline

Checks if a timer is currently active. Returns true if the timer is active, otherwise false.

◆ time_to_next()

uint32_t etl::icallback_timer::time_to_next ( ) const
inline

Get the time to the next timer event. Returns etl::timer::interval::No_Active_Interval if there is no active timer.

◆ unregister_timer()

bool etl::icallback_timer::unregister_timer ( etl::timer::id::type  id_)
inline

Register a timer.

Unregister a timer.


The documentation for this class was generated from the following file: