OpenSDN source code
SandeshPortSubscribeTask Class Reference
Inheritance diagram for SandeshPortSubscribeTask:
Collaboration diagram for SandeshPortSubscribeTask:

Public Member Functions

 SandeshPortSubscribeTask (Agent *agent, const std::string &context)
 
virtual ~SandeshPortSubscribeTask ()
 
- Public Member Functions inherited from Task
 Task (int task_id, int task_data_id)
 Creates a new task with the given values of task code ID and task data ID. More...
 
 Task (int task_id)
 Creates a new task with the given value of task code ID and wildcard for task data ID. More...
 
virtual ~Task ()
 Destroys a task. More...
 
virtual bool Run ()=0
 Code to execute in a task. Returns true if task is completed. Return false to reschedule the task. More...
 
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 state () const
 Returns a state value of a task. More...
 
int task_code_id () const
 Returns the code ID of this task. More...
 
int task_data_id () const
 Returns the data ID of this task. More...
 
uint64_t seqno () const
 Returns the sequence number of this task. More...
 
bool task_cancelled () const
 Returns true if the task has been canceled. More...
 
virtual std::string Description () const =0
 Gives a description of the task. More...
 
uint64_t enqueue_time () const
 Returns the time when the task was enqueued for execution. More...
 
uint64_t schedule_time () const
 Returns the time when the task execution was started. More...
 
uint32_t execute_delay () const
 Returns the threshold for the task execution duration. More...
 
uint32_t schedule_delay () const
 Returns the time threshold for time difference between moments when the task was started and when it was enqueue. More...
 

Protected Member Functions

 DISALLOW_COPY_AND_ASSIGN (SandeshPortSubscribeTask)
 

Protected Attributes

Agentagent_
 
const PortSubscribeTabletable_
 
std::string context_
 

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 }
 Describes states of a task according to TBB library. More...
 
- 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
 Specifies value for wildcard (any or *) task data ID. More...
 

Detailed Description

Definition at line 595 of file port_subscribe_table.cc.

Constructor & Destructor Documentation

◆ SandeshPortSubscribeTask()

SandeshPortSubscribeTask::SandeshPortSubscribeTask ( Agent agent,
const std::string &  context 
)
inline

Definition at line 597 of file port_subscribe_table.cc.

◆ ~SandeshPortSubscribeTask()

virtual SandeshPortSubscribeTask::~SandeshPortSubscribeTask ( )
inlinevirtual

Definition at line 603 of file port_subscribe_table.cc.

Member Function Documentation

◆ DISALLOW_COPY_AND_ASSIGN()

SandeshPortSubscribeTask::DISALLOW_COPY_AND_ASSIGN ( SandeshPortSubscribeTask  )
protected

Member Data Documentation

◆ agent_

Agent* SandeshPortSubscribeTask::agent_
protected

Definition at line 606 of file port_subscribe_table.cc.

◆ context_

std::string SandeshPortSubscribeTask::context_
protected

Definition at line 608 of file port_subscribe_table.cc.

◆ table_

const PortSubscribeTable* SandeshPortSubscribeTask::table_
protected

Definition at line 607 of file port_subscribe_table.cc.


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