Scheduling parameters for a task posted via MessageLoop::exec_task(). More...

#include <schedule.h>

Collaboration diagram for vlink::Schedule::Config:

Public Member Functions
	Config ()
	Constructs a default `Config` with all fields set to zero.
	Config (uint32_t _delay_ms, uint16_t _priority=0, uint32_t _schedule_timeout_ms=0, uint32_t _execution_timeout_ms=0)
	Constructs a `Config` with all fields specified.

Public Attributes
uint32_t	delay_ms {0}
	Delay in ms before the task is posted.
uint16_t	priority {0}
	Dispatch priority (higher = sooner).
uint32_t	schedule_timeout_ms {0}
	Max ms to wait before task starts. 0 = disabled.
uint32_t	execution_timeout_ms {0}
	Max ms the task may execute. 0 = disabled.

Detailed Description

Scheduling parameters for a task posted via MessageLoop::exec_task().

All fields are optional; defaults result in immediate posting with no timeouts.

Constructor & Destructor Documentation

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

Constructs a default Config with all fields set to zero.

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 Config with all fields specified.

Parameters

_delay_ms	Delay before posting in milliseconds. 0 = immediate.
_priority	Task dispatch priority. 0 = default.
_schedule_timeout_ms	Max wait before the task starts (0 = no timeout).
_execution_timeout_ms	Max execution time of the task (0 = no timeout).

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

Delay in ms before the task is posted.

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

Max ms the task may execute. 0 = disabled.

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

Dispatch priority (higher = sooner).

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

Max ms to wait before task starts. 0 = disabled.

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