VLink  2.0.0
A high-performance communication middleware
vlink::Schedule::Config Struct Referencefinal

Scheduling parameters captured at the call to exec_task(). More...

#include <schedule.h>

Collaboration diagram for vlink::Schedule::Config:

Public Member Functions

 Config ()
 Constructs a default Config with every field zero-initialised. More...
 
 Config (uint32_t _delay_ms, uint16_t _priority=0, uint32_t _schedule_timeout_ms=0, uint32_t _execution_timeout_ms=0)
 Constructs a fully populated Config. More...
 

Public Attributes

uint32_t delay_ms {0}
 Delay before posting; 0 posts immediately. More...
 
uint16_t priority {0}
 Dispatch priority hint; higher fires sooner. More...
 
uint32_t schedule_timeout_ms {0}
 Queue-wait budget after the delay; 0 disables. More...
 
uint32_t execution_timeout_ms {0}
 Execution budget per callback; 0 disables. More...
 

Detailed Description

Scheduling parameters captured at the call to exec_task().

All fields default to zero, which corresponds to immediate dispatch with no timeouts.

Constructor & Destructor Documentation

◆ Config() [1/2]

vlink::Schedule::Config::Config ( )

Constructs a default Config with every field zero-initialised.

◆ Config() [2/2]

vlink::Schedule::Config::Config ( uint32_t  _delay_ms,
uint16_t  _priority = 0,
uint32_t  _schedule_timeout_ms = 0,
uint32_t  _execution_timeout_ms = 0 
)
explicit

Constructs a fully populated Config.

Parameters
_delay_msDelay before posting in milliseconds.
_priorityDispatch priority for priority-aware loops.
_schedule_timeout_msMaximum queue-wait budget after the delay.
_execution_timeout_msMaximum execution budget per callback in the chain.

Member Data Documentation

◆ delay_ms

uint32_t vlink::Schedule::Config::delay_ms {0}

Delay before posting; 0 posts immediately.

◆ execution_timeout_ms

uint32_t vlink::Schedule::Config::execution_timeout_ms {0}

Execution budget per callback; 0 disables.

◆ priority

uint16_t vlink::Schedule::Config::priority {0}

Dispatch priority hint; higher fires sooner.

◆ schedule_timeout_ms

uint32_t vlink::Schedule::Config::schedule_timeout_ms {0}

Queue-wait budget after the delay; 0 disables.


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