#include <scheduled_task.hpp>

Public Member Functions
	scheduled_task (scheduled_task const &)=default

	scheduled_task (scheduled_task &&) noexcept=default

auto	operator= (scheduled_task const &) -> scheduled_task &=default

auto	operator= (scheduled_task &&) noexcept -> scheduled_task &=default

void	cancel ()
	Request cancellation of the scheduled task.

auto	is_cancelled () const noexcept -> bool
	Return whether cancellation has been requested/observed.

auto	id () const noexcept -> std::uint64_t
	Return the backend-assigned task identifier.

Friends
class	scheduled_pool

struct	detail::scheduled_task_access

Detailed Description

Definition at line 20 of file scheduled_task.hpp.

Constructor & Destructor Documentation

◆ scheduled_task() [1/2]

threadschedule::scheduled_task::scheduled_task ( scheduled_task const & )

default

◆ scheduled_task() [2/2]

threadschedule::scheduled_task::scheduled_task ( scheduled_task && )

defaultnoexcept

Member Function Documentation

◆ cancel()

void threadschedule::scheduled_task::cancel ( )

inline

Request cancellation of the scheduled task.

Cancellation is best-effort and may be ignored if the task is already running or has completed.

Definition at line 35 of file scheduled_task.hpp.

References threadschedule::detail::scheduled_task_backend::cancel().

◆ id()

auto threadschedule::scheduled_task::id ( ) const -> std::uint64_t

inlinenoexcept

Return the backend-assigned task identifier.

Definition at line 53 of file scheduled_task.hpp.

References threadschedule::detail::scheduled_task_backend::id().

◆ is_cancelled()

auto threadschedule::scheduled_task::is_cancelled ( ) const -> bool

inlinenoexcept

Return whether cancellation has been requested/observed.

Definition at line 44 of file scheduled_task.hpp.

References threadschedule::detail::scheduled_task_backend::is_cancelled().

◆ operator=() [1/2]

auto threadschedule::scheduled_task::operator= ( scheduled_task && ) -> scheduled_task &=default

defaultnoexcept

◆ operator=() [2/2]

auto threadschedule::scheduled_task::operator= ( scheduled_task const & ) -> scheduled_task &=default

default

Friends And Related Symbol Documentation

◆ detail::scheduled_task_access

friend struct detail::scheduled_task_access

friend

Definition at line 63 of file scheduled_task.hpp.

◆ scheduled_pool

friend class scheduled_pool