Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
message_timer< MAX_TIMERS_ > Class Template Reference
The message timer. More...
#include <message_timer.h>
Inherits etl::imessage_timer.
Public Member Functions | |
| message_timer () | |
| Constructor. | |
| 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 | 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. | |
Detailed Description
template<uint_least8_t MAX_TIMERS_>
class etl::message_timer< MAX_TIMERS_ >
The message timer.
Definition at line 636 of file message_timer.h.
Constructor & Destructor Documentation
| message_timer | ( | ) |
Constructor.
Definition at line 645 of file message_timer.h.
Member Function Documentation
| void clear | ( | ) | [inherited] |
Clears the timer of data.
Definition at line 409 of file message_timer.h.
| void enable | ( | bool | state_ ) | [inherited] |
Enable/disable the timer.
Definition at line 393 of file message_timer.h.
| bool is_running | ( | ) | const [inherited] |
Get the enable/disable state.
Definition at line 401 of file message_timer.h.
| 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 |
||
| ) | [inherited] |
Register a timer.
Definition at line 318 of file message_timer.h.
| bool set_mode | ( | etl::timer::id::type | id_, |
| bool | repeating_ | ||
| ) | [inherited] |
Sets a timer's mode.
Definition at line 573 of file message_timer.h.
| bool set_period | ( | etl::timer::id::type | id_, |
| uint32_t | period_ | ||
| ) | [inherited] |
Sets a timer's period.
Definition at line 559 of file message_timer.h.
| bool start | ( | etl::timer::id::type | id_, |
| bool | immediate_ = false |
||
| ) | [inherited] |
Starts a timer.
Definition at line 491 of file message_timer.h.
| bool stop | ( | etl::timer::id::type | id_ ) | [inherited] |
Stops a timer.
Definition at line 529 of file message_timer.h.
| bool unregister_timer | ( | etl::timer::id::type | id_ ) | [inherited] |
Unregister a timer.
Definition at line 360 of file message_timer.h.
Generated on Tue Jul 12 2022 14:05:52 by
1.7.2