Scheduler that executes delayed and periodic tasks on worker threads. More...

#include <scheduled_pool.hpp>

Public Member Functions
	scheduled_pool ()
	Construct with default scheduler configuration.

	scheduled_pool (worker_count count)
	Construct with explicit worker count.

	scheduled_pool (scheduled_pool_config config)
	Construct from full configuration.

	scheduled_pool (scheduled_pool &&other) noexcept

auto	operator= (scheduled_pool &&other) noexcept -> scheduled_pool &

	scheduled_pool (scheduled_pool const &)=delete

auto	operator= (scheduled_pool const &) -> scheduled_pool &=delete

	~scheduled_pool ()
	Shutdown scheduler and workers according to configured policy.

template<typename Rep , typename Period , typename F >
auto	schedule_after (std::chrono::duration< Rep, Period > delay, F &&function) -> result< scheduled_task >
	Schedule a one-shot task to run after a delay.

template<typename F >
auto	schedule_at (std::chrono::steady_clock::time_point time, F &&function) -> result< scheduled_task >
	Schedule a one-shot task at an absolute time point.

template<typename Rep , typename Period , typename F >
auto	schedule_periodic (std::chrono::duration< Rep, Period > interval, F &&function) -> result< scheduled_task >
	Schedule a periodic task.

template<typename InitialRep , typename InitialPeriod , typename IntervalRep , typename IntervalPeriod , typename F >
auto	schedule_periodic_after (std::chrono::duration< InitialRep, InitialPeriod > initial_delay, std::chrono::duration< IntervalRep, IntervalPeriod > interval, F &&function) -> result< scheduled_task >
	Schedule a periodic task with initial delay.

auto	shutdown () -> result< void >
	Shutdown using configured shutdown policy.

auto	shutdown (shutdown_policy policy) -> result< void >
	Shutdown with explicit policy.

auto	scheduled_count () const -> std::size_t
	Return count of tasks currently tracked by the scheduler backend.

Static Public Member Functions
static auto	create (scheduled_pool_config config={}) -> result< scheduled_pool >
	Create a scheduled pool without exceptions.

Detailed Description

Scheduler that executes delayed and periodic tasks on worker threads.

Definition at line 129 of file scheduled_pool.hpp.

Constructor & Destructor Documentation

◆ scheduled_pool() [1/5]

threadschedule::scheduled_pool::scheduled_pool ( )

inline

Construct with default scheduler configuration.

Definition at line 133 of file scheduled_pool.hpp.

◆ scheduled_pool() [2/5]

threadschedule::scheduled_pool::scheduled_pool ( worker_count count )

inlineexplicit

Construct with explicit worker count.

Parameters

count Number of worker threads or automatic resolution mode.

Definition at line 139 of file scheduled_pool.hpp.

◆ scheduled_pool() [3/5]

threadschedule::scheduled_pool::scheduled_pool ( scheduled_pool_config config )

inlineexplicit

Construct from full configuration.

Parameters

config Scheduler configuration.

Exceptions

std::system_error if worker/scheduler thread configuration fails.

Definition at line 146 of file scheduled_pool.hpp.

References threadschedule::scheduled_pool_config::get_scheduler_config(), threadschedule::scheduled_pool_config::get_worker_config(), threadschedule::detail::has_thread_configuration(), and threadschedule::detail::to_native().

◆ scheduled_pool() [4/5]

threadschedule::scheduled_pool::scheduled_pool ( scheduled_pool && other )

inlinenoexcept

Definition at line 166 of file scheduled_pool.hpp.

◆ scheduled_pool() [5/5]

threadschedule::scheduled_pool::scheduled_pool ( scheduled_pool const & )

delete

◆ ~scheduled_pool()

threadschedule::scheduled_pool::~scheduled_pool ( )

inline

Shutdown scheduler and workers according to configured policy.

Definition at line 192 of file scheduled_pool.hpp.

Member Function Documentation

◆ create()

static auto threadschedule::scheduled_pool::create ( scheduled_pool_config config = {} ) -> result<scheduled_pool>

inlinestatic

Create a scheduled pool without exceptions.

Parameters

config Scheduler configuration.

Returns: A ready-to-use pool or an error code.

Definition at line 203 of file scheduled_pool.hpp.

◆ operator=() [1/2]

auto threadschedule::scheduled_pool::operator= ( scheduled_pool && other ) -> scheduled_pool&

inlinenoexcept

Definition at line 174 of file scheduled_pool.hpp.

◆ operator=() [2/2]

auto threadschedule::scheduled_pool::operator= ( scheduled_pool const & ) -> scheduled_pool &=delete

delete

◆ schedule_after()

template<typename Rep , typename Period , typename F >

auto threadschedule::scheduled_pool::schedule_after	(	std::chrono::duration< Rep, Period >	delay,
		F &&	function
	)		-> result<scheduled_task>

inline

Schedule a one-shot task to run after a delay.

Parameters

delay	Relative delay before first execution.
function	Callable to execute.

Returns: Task handle or error (for example canceled).

Definition at line 216 of file scheduled_pool.hpp.

References threadschedule::detail::try_result().

◆ schedule_at()

template<typename F >

auto threadschedule::scheduled_pool::schedule_at	(	std::chrono::steady_clock::time_point	time,
		F &&	function
	)		-> result<scheduled_task>

inline

Schedule a one-shot task at an absolute time point.

Parameters

time	Absolute `steady_clock` timestamp.
function	Callable to execute.

Definition at line 240 of file scheduled_pool.hpp.

References threadschedule::detail::try_result().

◆ schedule_periodic()

template<typename Rep , typename Period , typename F >

auto threadschedule::scheduled_pool::schedule_periodic	(	std::chrono::duration< Rep, Period >	interval,
		F &&	function
	)		-> result<scheduled_task>

inline

Schedule a periodic task.

Parameters

interval	Execution interval; must be > 0.
function	Callable to execute each tick.

Returns: Task handle or errc::invalid_argument for non-positive interval.

Definition at line 262 of file scheduled_pool.hpp.

References threadschedule::detail::try_result().

◆ schedule_periodic_after()

template<typename InitialRep , typename InitialPeriod , typename IntervalRep , typename IntervalPeriod , typename F >

auto threadschedule::scheduled_pool::schedule_periodic_after	(	std::chrono::duration< InitialRep, InitialPeriod >	initial_delay,
		std::chrono::duration< IntervalRep, IntervalPeriod >	interval,
		F &&	function
	)		-> result<scheduled_task>

inline

Schedule a periodic task with initial delay.

Parameters

initial_delay	Delay before first execution.
interval	Period between executions; must be > 0.
function	Callable to execute.

Definition at line 289 of file scheduled_pool.hpp.

References threadschedule::detail::try_result().

◆ scheduled_count()

auto threadschedule::scheduled_pool::scheduled_count ( ) const -> std::size_t

inline

Return count of tasks currently tracked by the scheduler backend.

Definition at line 341 of file scheduled_pool.hpp.

◆ shutdown() [1/2]

auto threadschedule::scheduled_pool::shutdown ( ) -> result<void>

inline

Shutdown using configured shutdown policy.

Definition at line 316 of file scheduled_pool.hpp.

References threadschedule::scheduled_pool_config::get_shutdown_policy(), and shutdown().

Referenced by shutdown().

◆ shutdown() [2/2]

auto threadschedule::scheduled_pool::shutdown ( shutdown_policy policy ) -> result<void>

inline

Shutdown with explicit policy.

Parameters

policy Drain/cancel behavior for pending tasks.

Definition at line 326 of file scheduled_pool.hpp.

References threadschedule::detail::to_native(), and threadschedule::detail::try_result().

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

scheduled_pool.hpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ scheduled_pool() [1/5]

◆ scheduled_pool() [2/5]

◆ scheduled_pool() [3/5]

◆ scheduled_pool() [4/5]

◆ scheduled_pool() [5/5]

◆ ~scheduled_pool()

Member Function Documentation

◆ create()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ schedule_after()

◆ schedule_at()

◆ schedule_periodic()

◆ schedule_periodic_after()

◆ scheduled_count()

◆ shutdown() [1/2]

◆ shutdown() [2/2]