Embedded Template Library 1.0
Loading...
Searching...
No Matches
etl::message_timer_interrupt< Max_Timers_, TInterruptGuard > Class Template Reference

The message timer. More...

#include <message_timer_interrupt.h>

Public Types

typedef imessage_timer_interrupt< TInterruptGuard >::callback_type callback_type
Public Types inherited from etl::imessage_timer_interrupt< TInterruptGuard >
typedef etl::delegate< void(void)> callback_type
typedef etl::delegate< void(etl::timer::id::type)> event_callback_type

Public Member Functions

 ETL_STATIC_ASSERT (Max_Timers_<=254, "No more than 254 timers are allowed")
 message_timer_interrupt ()
 Constructor.
Public Member Functions inherited from etl::imessage_timer_interrupt< TInterruptGuard >
etl::timer::id::type register_timer (const etl::imessage &message_, etl::imessage_router &router_, uint32_t period_, bool repeating_, etl::message_router_id_t destination_router_id_=etl::imessage_router::ALL_MESSAGE_ROUTERS)
 Register a timer.
bool unregister_timer (etl::timer::id::type id_)
 Unregister 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
void set_insert_callback (event_callback_type insert_)
 Set a callback when a timer is inserted on list.
void set_remove_callback (event_callback_type remove_)
 Set a callback when a timer is removed from list.
void clear_insert_callback ()
void clear_remove_callback ()

Additional Inherited Members

Public Attributes inherited from etl::imessage_timer_interrupt< TInterruptGuard >
const uint_least8_t Max_Timers
Protected Member Functions inherited from etl::imessage_timer_interrupt< TInterruptGuard >
 imessage_timer_interrupt (timer_data *const timer_array_, const uint_least8_t Max_Timers_)
 Constructor.
 ~imessage_timer_interrupt ()
 Destructor.

Detailed Description

template<uint_least8_t Max_Timers_, typename TInterruptGuard>
class etl::message_timer_interrupt< Max_Timers_, TInterruptGuard >

The message timer.


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