Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
roc::ctl Namespace Reference

Control tasks event loop. More...

Classes

class  BasicControlEndpoint
 Base class for control endpoints. More...
 
class  ControlInterfaceMap
 Control interface map. More...
 
class  ControlLoop
 Control loop thread. More...
 
class  ControlTask
 Base class for control tasks. More...
 
class  IControlTaskExecutor
 Control task executor interface. More...
 
class  ControlTaskExecutor
 Control task executor. More...
 
class  ControlTaskQueue
 Control task queue. More...
 
class  IControlTaskCompleter
 Control task completion handler. More...
 

Typedefs

typedef ControlTaskResult(IControlTaskExecutor::* ControlTaskFunc) (ControlTask &)
 Control task implementation function. Holds a pointer to method of a class derived from IControlTaskExecutor. More...
 

Enumerations

enum  ControlTaskResult { ControlTaskSuccess , ControlTaskFailure , ControlTaskContinue , ControlTaskPause }
 Control task execution result. More...
 

Detailed Description

Control tasks event loop.

Typedef Documentation

◆ ControlTaskFunc

typedef ControlTaskResult(IControlTaskExecutor::* roc::ctl::ControlTaskFunc) (ControlTask &)

Control task implementation function. Holds a pointer to method of a class derived from IControlTaskExecutor.

Definition at line 50 of file control_task.h.

Enumeration Type Documentation

◆ ControlTaskResult

Control task execution result.

Enumerator
ControlTaskSuccess 

Task completed with success.

ControlTaskFailure 

Task completed with failure.

ControlTaskContinue 

Task wants to be re-executed again as soon as possible.

ControlTaskPause 

Task wants to be paused until is explicitly resumed.

Definition at line 34 of file control_task.h.