#include <ordered_tasks.h>

Inherits ccf::tasks::BaseTask, and std::enable_shared_from_this< OrderedTasks >.

Classes
struct	PImpl

struct	Private

struct	ResumeOrderedTasks

Public Member Functions
	OrderedTasks (Private force_private_constructor, JobBoard &job_board, const std::string &name)

	~OrderedTasks () override

ccf::tasks::Resumable	pause () override

const std::string &	get_name () const override

void	add_action (TaskAction &&action)

void	get_queue_summary (size_t &num_pending, bool &is_active)

Public Member Functions inherited from ccf::tasks::BaseTask
virtual	~BaseTask ()=default

void	do_task ()

void	cancel_task ()

bool	is_cancelled ()

Static Public Member Functions
static std::shared_ptr< OrderedTasks >	create (JobBoard &job_board_, const std::string &name_="[Ordered]")

Protected Member Functions
void	enqueue_on_board ()

void	do_task_implementation () override

Protected Attributes
std::unique_ptr< PImpl >	pimpl = nullptr

Constructor & Destructor Documentation

◆ OrderedTasks()

ccf::tasks::OrderedTasks::OrderedTasks	(	OrderedTasks::Private	force_private_constructor,
		JobBoard &	job_board,
		const std::string &	name
	)

◆ ~OrderedTasks()

ccf::tasks::OrderedTasks::~OrderedTasks ( )

overridedefault

Member Function Documentation

◆ add_action()

void ccf::tasks::OrderedTasks::add_action ( TaskAction && action )

◆ create()

std::shared_ptr< OrderedTasks > ccf::tasks::OrderedTasks::create	(	JobBoard &	job_board_,
		const std::string &	name_ = `"[Ordered]"`
	)

static

◆ do_task_implementation()

void ccf::tasks::OrderedTasks::do_task_implementation ( )

overrideprotectedvirtual

Implements ccf::tasks::BaseTask.

◆ enqueue_on_board()

void ccf::tasks::OrderedTasks::enqueue_on_board ( )

protected

◆ get_name()

const std::string & ccf::tasks::OrderedTasks::get_name ( ) const

overridevirtual

Implements ccf::tasks::BaseTask.

◆ get_queue_summary()

void ccf::tasks::OrderedTasks::get_queue_summary	(	size_t &	num_pending,
		bool &	is_active
	)

◆ pause()

ccf::tasks::Resumable ccf::tasks::OrderedTasks::pause ( )

overridevirtual

Reimplemented from ccf::tasks::BaseTask.

Member Data Documentation

◆ pimpl

std::unique_ptr<PImpl> ccf::tasks::OrderedTasks::pimpl = nullptr