POD command record passed from the public API methods to the tick task via the command queue. More...

Collaboration diagram for stk::time::TimerHost::TimerCommand:

Public Types
enum	EId : uint8_t { CMD_SHUTDOWN = 0 , CMD_START , CMD_STOP , CMD_RESET , CMD_RESTART , CMD_START_OR_RESET , CMD_SET_PERIOD }
	Identifies the operation to perform on the target timer. More...

Public Attributes
EId	cmd
	command id
Timer *	timer
	timer instance
Ticks	timestamp
	hw tick count captured at call site
uint32_t	delay
	initial delay ticks (CMD_START / CMD_RESTART / CMD_START_OR_RESET)
uint32_t	period
	reload period ticks (CMD_START / CMD_RESTART / CMD_START_OR_RESET / CMD_SET_PERIOD)

Detailed Description

POD command record passed from the public API methods to the tick task via the command queue.

Each command encodes a single operation together with the timer pointer, a call-site timestamp, and optional delay/period arguments. Commands are produced by the public API (Start, Stop, Reset, …) and consumed exclusively by the tick task inside ProcessCommands().

Definition at line 394 of file stk_time_timer.h.

Member Enumeration Documentation

◆ EId

enum stk::time::TimerHost::TimerCommand::EId : uint8_t

Identifies the operation to perform on the target timer.

Enumerator
CMD_SHUTDOWN	shutdown timer host
CMD_START	start timer
CMD_STOP	stop timer
CMD_RESET	reset timer
CMD_RESTART	atomic stop + re-start
CMD_START_OR_RESET	start if inactive, reset deadline if active and periodic
CMD_SET_PERIOD	change period of a running periodic timer

Definition at line 399 of file stk_time_timer.h.

        {
            CMD_SHUTDOWN = 0,   
            CMD_START,          
            CMD_STOP,           
            CMD_RESET,          
            CMD_RESTART,        
            CMD_START_OR_RESET, 
            CMD_SET_PERIOD      
        };