OpenSDN source code
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
QueueTaskRunner< QueueEntryT, QueueT > Class Template Reference

#include <queue_task.h>

Inheritance diagram for QueueTaskRunner< QueueEntryT, QueueT >:
Collaboration diagram for QueueTaskRunner< QueueEntryT, QueueT >:

Public Member Functions

 QueueTaskRunner (QueueT *queue)
 
bool Run ()
 Code to execute. Returns true if task is completed. Return false to reschedule the task. More...
 
virtual 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 Member Functions

bool RunQueue ()
 

Private Attributes

QueueT * queue_
 

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

template<typename QueueEntryT, typename QueueT>
class QueueTaskRunner< QueueEntryT, QueueT >

Definition at line 31 of file queue_task.h.

Constructor & Destructor Documentation

template<typename QueueEntryT, typename QueueT>
QueueTaskRunner< QueueEntryT, QueueT >::QueueTaskRunner ( QueueT *  queue)
inline

Definition at line 33 of file queue_task.h.

Member Function Documentation

template<typename QueueEntryT, typename QueueT>
virtual std::string QueueTaskRunner< QueueEntryT, QueueT >::Description ( ) const
inlinevirtual

Implements Task.

Definition at line 48 of file queue_task.h.

template<typename QueueEntryT, typename QueueT>
bool QueueTaskRunner< QueueEntryT, QueueT >::Run ( )
inlinevirtual

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

Implements Task.

Definition at line 37 of file queue_task.h.

template<typename QueueEntryT, typename QueueT>
bool QueueTaskRunner< QueueEntryT, QueueT >::RunQueue ( )
inlineprivate

Definition at line 53 of file queue_task.h.

Member Data Documentation

template<typename QueueEntryT, typename QueueT>
QueueT* QueueTaskRunner< QueueEntryT, QueueT >::queue_
private

Definition at line 86 of file queue_task.h.


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