roc::ctl::ControlTask Class Reference

Base class for control tasks. More...

#include <roc_ctl/control_task.h>

Inheritance diagram for roc::ctl::ControlTask:

Public Member Functions
bool	completed () const
	True if the task succeeded, failed, or cancelled.
bool	succeeded () const
	True if the task succeeded.
bool	cancelled () const
	True if the task cancelled.
Public Member Functions inherited from roc::core::MpscQueueNode< Tag >
MpscQueueData *	mpsc_queue_data () const
	Get pointer to internal data.
Public Member Functions inherited from roc::core::ListNode< Tag >
ListData *	list_data () const
	Get pointer to internal data.

Protected Member Functions
template<class E >
	ControlTask (ControlTaskResult(E::*task_func)(ControlTask &))
	Initialize task.

Friends
class	ControlTaskQueue

Additional Inherited Members
Static Public Member Functions inherited from roc::core::MpscQueueNode< Tag >
static MpscQueueNode *	mpsc_queue_node (MpscQueueData *data)
	Get pointer to parent node from pointer to internal data.
Static Public Member Functions inherited from roc::core::ListNode< Tag >
static ListNode *	list_node (ListData *data)
	Get pointer to parent node from pointer to internal data.

Detailed Description

Base class for control tasks.

Definition at line 53 of file control_task.h.

Constructor & Destructor Documentation

ControlTask()

template<class E >

roc::ctl::ControlTask::ControlTask ( ControlTaskResult(E::*)(ControlTask &)  task_func )

inlineprotected

Initialize task.

Template Parameters

E	is a class derived from IControlTaskExecutor. task_func is a method of E which implements the task.

Definition at line 71 of file control_task.h.

Member Function Documentation

cancelled()

bool roc::ctl::ControlTask::cancelled

(

)

const

True if the task cancelled.

completed()

bool roc::ctl::ControlTask::completed

(

)

const

True if the task succeeded, failed, or cancelled.

succeeded()

bool roc::ctl::ControlTask::succeeded

(

)

const

True if the task succeeded.

Friends And Related Symbol Documentation

ControlTaskQueue

friend class ControlTaskQueue

friend

Definition at line 88 of file control_task.h.

---

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

• roc_ctl/control_task.h