Scheduled task definition. More...

#include <task_scheduler_config.h>

Collaboration diagram for kcenon::pacs::workflow::scheduled_task:

Public Attributes
task_id	id
	Unique task ID.

std::string	name
	Human-readable task name.

std::string	description
	Task description.

task_type	type {task_type::custom}
	Task type.

schedule	task_schedule
	Schedule for execution.

task_state	state {task_state::pending}
	Current state.

task_callback_with_result	callback
	Task callback.

bool	enabled {true}
	Whether task is enabled.

int	priority {0}
	Task priority (higher = more important)

std::set< std::string >	tags
	Tags for categorization.

std::chrono::seconds	timeout {0}
	Maximum execution time (0 = no limit)

std::size_t	max_retries {0}
	Number of retry attempts on failure.

std::chrono::seconds	retry_delay {60}
	Delay between retries.

std::chrono::system_clock::time_point	created_at
	Creation time.

std::chrono::system_clock::time_point	updated_at
	Last modification time.

std::optional< std::chrono::system_clock::time_point >	next_run_at
	Next scheduled execution time.

std::optional< std::chrono::system_clock::time_point >	last_run_at
	Last execution time.

std::optional< task_execution_record >	last_execution
	Last execution result.

std::size_t	execution_count {0}
	Total execution count.

std::size_t	success_count {0}
	Successful execution count.

std::size_t	failure_count {0}
	Failed execution count.

Detailed Description

Scheduled task definition.

Definition at line 274 of file task_scheduler_config.h.

Member Data Documentation

◆ callback

task_callback_with_result kcenon::pacs::workflow::scheduled_task::callback

Task callback.

Definition at line 294 of file task_scheduler_config.h.

Referenced by kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule_archive(), kcenon::pacs::workflow::task_scheduler::schedule_cleanup(), kcenon::pacs::workflow::task_scheduler::schedule_once(), and kcenon::pacs::workflow::task_scheduler::schedule_verification().

◆ created_at

std::chrono::system_clock::time_point kcenon::pacs::workflow::scheduled_task::created_at

Creation time.

Definition at line 315 of file task_scheduler_config.h.

Referenced by kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule_archive(), kcenon::pacs::workflow::task_scheduler::schedule_cleanup(), kcenon::pacs::workflow::task_scheduler::schedule_once(), and kcenon::pacs::workflow::task_scheduler::schedule_verification().

◆ description

std::string kcenon::pacs::workflow::scheduled_task::description

Task description.

Definition at line 282 of file task_scheduler_config.h.

Referenced by kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule_archive(), kcenon::pacs::workflow::task_scheduler::schedule_cleanup(), kcenon::pacs::workflow::task_scheduler::schedule_once(), and kcenon::pacs::workflow::task_scheduler::schedule_verification().

◆ enabled

bool kcenon::pacs::workflow::scheduled_task::enabled {true}

Whether task is enabled.

Definition at line 297 of file task_scheduler_config.h.

297{true};

Referenced by kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule_archive(), kcenon::pacs::workflow::task_scheduler::schedule_cleanup(), kcenon::pacs::workflow::task_scheduler::schedule_once(), and kcenon::pacs::workflow::task_scheduler::schedule_verification().

◆ execution_count

std::size_t kcenon::pacs::workflow::scheduled_task::execution_count {0}

Total execution count.

Definition at line 330 of file task_scheduler_config.h.

330{0};

◆ failure_count

std::size_t kcenon::pacs::workflow::scheduled_task::failure_count {0}

Failed execution count.

Definition at line 336 of file task_scheduler_config.h.

336{0};

◆ id

task_id kcenon::pacs::workflow::scheduled_task::id

Unique task ID.

Definition at line 276 of file task_scheduler_config.h.

Referenced by kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule_archive(), kcenon::pacs::workflow::task_scheduler::schedule_cleanup(), kcenon::pacs::workflow::task_scheduler::schedule_once(), and kcenon::pacs::workflow::task_scheduler::schedule_verification().

◆ last_execution

std::optional<task_execution_record> kcenon::pacs::workflow::scheduled_task::last_execution

Last execution result.

Definition at line 327 of file task_scheduler_config.h.

◆ last_run_at

std::optional<std::chrono::system_clock::time_point> kcenon::pacs::workflow::scheduled_task::last_run_at

Last execution time.

Definition at line 324 of file task_scheduler_config.h.

◆ max_retries

std::size_t kcenon::pacs::workflow::scheduled_task::max_retries {0}

Number of retry attempts on failure.

Definition at line 309 of file task_scheduler_config.h.

309{0};

◆ name

std::string kcenon::pacs::workflow::scheduled_task::name

Human-readable task name.

Definition at line 279 of file task_scheduler_config.h.

Referenced by kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule_archive(), kcenon::pacs::workflow::task_scheduler::schedule_cleanup(), kcenon::pacs::workflow::task_scheduler::schedule_once(), and kcenon::pacs::workflow::task_scheduler::schedule_verification().

◆ next_run_at

std::optional<std::chrono::system_clock::time_point> kcenon::pacs::workflow::scheduled_task::next_run_at

Next scheduled execution time.

Definition at line 321 of file task_scheduler_config.h.

Referenced by kcenon::pacs::workflow::task_scheduler::schedule_once().

◆ priority

int kcenon::pacs::workflow::scheduled_task::priority {0}

Task priority (higher = more important)

Definition at line 300 of file task_scheduler_config.h.

300{0};

Referenced by kcenon::pacs::workflow::task_scheduler::schedule_archive(), kcenon::pacs::workflow::task_scheduler::schedule_cleanup(), and kcenon::pacs::workflow::task_scheduler::schedule_verification().

◆ retry_delay

std::chrono::seconds kcenon::pacs::workflow::scheduled_task::retry_delay {60}

Delay between retries.

Definition at line 312 of file task_scheduler_config.h.

312{60};

◆ state

task_state kcenon::pacs::workflow::scheduled_task::state {task_state::pending}

Current state.

Definition at line 291 of file task_scheduler_config.h.

291{task_state::pending};

kcenon::pacs::workflow::task_state::pending

@ pending

Waiting for scheduled time.

◆ success_count

std::size_t kcenon::pacs::workflow::scheduled_task::success_count {0}

Successful execution count.

Definition at line 333 of file task_scheduler_config.h.

333{0};

◆ tags

std::set<std::string> kcenon::pacs::workflow::scheduled_task::tags

Tags for categorization.

Definition at line 303 of file task_scheduler_config.h.

Referenced by kcenon::pacs::workflow::task_scheduler::schedule_archive(), kcenon::pacs::workflow::task_scheduler::schedule_cleanup(), and kcenon::pacs::workflow::task_scheduler::schedule_verification().

◆ task_schedule

schedule kcenon::pacs::workflow::scheduled_task::task_schedule

Schedule for execution.

Definition at line 288 of file task_scheduler_config.h.

Referenced by kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule_archive(), kcenon::pacs::workflow::task_scheduler::schedule_cleanup(), kcenon::pacs::workflow::task_scheduler::schedule_once(), and kcenon::pacs::workflow::task_scheduler::schedule_verification().

◆ timeout

std::chrono::seconds kcenon::pacs::workflow::scheduled_task::timeout {0}

Maximum execution time (0 = no limit)

Definition at line 306 of file task_scheduler_config.h.

306{0};

◆ type

task_type kcenon::pacs::workflow::scheduled_task::type {task_type::custom}

Task type.

Definition at line 285 of file task_scheduler_config.h.

285{task_type::custom};

kcenon::pacs::workflow::task_type::custom

@ custom

User-defined task.

Referenced by kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule_archive(), kcenon::pacs::workflow::task_scheduler::schedule_cleanup(), kcenon::pacs::workflow::task_scheduler::schedule_once(), and kcenon::pacs::workflow::task_scheduler::schedule_verification().

◆ updated_at

std::chrono::system_clock::time_point kcenon::pacs::workflow::scheduled_task::updated_at

Last modification time.

Definition at line 318 of file task_scheduler_config.h.

Referenced by kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule(), kcenon::pacs::workflow::task_scheduler::schedule_archive(), kcenon::pacs::workflow::task_scheduler::schedule_cleanup(), kcenon::pacs::workflow::task_scheduler::schedule_once(), and kcenon::pacs::workflow::task_scheduler::schedule_verification().

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

include/kcenon/pacs/workflow/task_scheduler_config.h

Public Attributes

Detailed Description

Member Data Documentation

◆ callback

◆ created_at

◆ description

◆ enabled

◆ execution_count

◆ failure_count

◆ id

◆ last_execution

◆ last_run_at

◆ max_retries

◆ name

◆ next_run_at

◆ priority

◆ retry_delay

◆ state

◆ success_count

◆ tags

◆ task_schedule

◆ timeout

◆ type

◆ updated_at