OpenSDN source code
PipelineWorker Struct Reference

#include <work_processor-inl.h>

Inheritance diagram for PipelineWorker:
Collaboration diagram for PipelineWorker:

Public Member Functions

 PipelineWorker (int tid, int tinst, boost::function< bool(void)> runner)
 
bool Run ()
 Code to execute. Returns true if task is completed. Return false to reschedule the task. More...
 
std::string Description () const
 
- Public Member Functions inherited from Task
 Task (int task_id, int task_instance)
 
 Task (int task_id)
 
virtual ~Task ()
 
virtual void OnTaskCancel ()
 Called on task exit, if it is marked for cancellation. If the user wants to do any cleanup on task cancellation, then he/she can overload this function. More...
 
State GetState () const
 
int GetTaskId () const
 
int GetTaskInstance () const
 
uint64_t GetSeqno () const
 
bool task_cancelled () const
 
uint64_t enqueue_time () const
 
uint64_t schedule_time () const
 
uint32_t execute_delay () const
 
uint32_t schedule_delay () const
 

Private Attributes

const boost::function< bool(void)> runner_
 

Additional Inherited Members

- Public Types inherited from Task
enum  State { INIT , WAIT , RUN }
 Task states. More...
 
enum  TbbState { TBB_INIT , TBB_ENQUEUED , TBB_EXEC , TBB_DONE }
 
- Static Public Member Functions inherited from Task
static TaskRunning ()
 Returns a pointer to the current task the code is executing under. More...
 
- Static Public Attributes inherited from Task
static const int kTaskInstanceAny = -1
 

Detailed Description

Definition at line 22 of file work_processor-inl.h.

Constructor & Destructor Documentation

◆ PipelineWorker()

PipelineWorker::PipelineWorker ( int  tid,
int  tinst,
boost::function< bool(void)>  runner 
)
inline

Definition at line 23 of file work_processor-inl.h.

Member Function Documentation

◆ Description()

std::string PipelineWorker::Description ( ) const
inlinevirtual

Implements Task.

Definition at line 30 of file work_processor-inl.h.

◆ Run()

bool PipelineWorker::Run ( )
inlinevirtual

Code to execute. Returns true if task is completed. Return false to reschedule the task.

Implements Task.

Definition at line 26 of file work_processor-inl.h.

Member Data Documentation

◆ runner_

const boost::function<bool(void)> PipelineWorker::runner_
private

Definition at line 32 of file work_processor-inl.h.


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