roc::ctl::ControlTask Class Reference

Base class for control tasks. More...

#include <control_task.h>

Inheritance diagram for roc::ctl::ControlTask:

Collaboration diagram for roc::ctl::ControlTask:

Public Member Functions
bool	completed () const
	True if the task succeeded, failed, or cancelled. More...
bool	succeeded () const
	True if the task succeeded. More...
bool	cancelled () const
	True if the task cancelled. More...
Public Member Functions inherited from roc::core::MpscQueueNode
MpscQueueData *	mpsc_queue_data () const
	Get list node data. More...
Public Member Functions inherited from roc::core::ListNode
ListNodeData *	list_node_data () const
	Get list node data. More...

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

Friends
class	ControlTaskQueue

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.

---

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

• roc_ctl/control_task.h