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

Public Member Functions

 VxLanConfigSandeshTask (Agent *agent, uint32_t vxlan_id, const string &vn, const string &active, const string &context)
 
 ~VxLanConfigSandeshTask ()
 
virtual bool Run ()
 Code to execute in a task. Returns true if task is completed. Return false to reschedule the task. More...
 
std::string Description () const
 Gives a description of the task. More...
 
- 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 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...
 
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...
 

Private Member Functions

 DISALLOW_COPY_AND_ASSIGN (VxLanConfigSandeshTask)
 

Private Attributes

Agentagent_
 
uint32_t vxlan_id_
 
string vn_
 
string active_
 
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 442 of file vxlan.cc.

Constructor & Destructor Documentation

◆ VxLanConfigSandeshTask()

VxLanConfigSandeshTask::VxLanConfigSandeshTask ( Agent agent,
uint32_t  vxlan_id,
const string &  vn,
const string &  active,
const string &  context 
)
inline

Definition at line 444 of file vxlan.cc.

◆ ~VxLanConfigSandeshTask()

VxLanConfigSandeshTask::~VxLanConfigSandeshTask ( )
inline

Definition at line 449 of file vxlan.cc.

Member Function Documentation

◆ Description()

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

Gives a description of the task.

Implements Task.

Definition at line 451 of file vxlan.cc.

◆ DISALLOW_COPY_AND_ASSIGN()

VxLanConfigSandeshTask::DISALLOW_COPY_AND_ASSIGN ( VxLanConfigSandeshTask  )
private

◆ Run()

bool VxLanConfigSandeshTask::Run ( )
virtual

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

Implements Task.

Definition at line 462 of file vxlan.cc.

Here is the call graph for this function:

Member Data Documentation

◆ active_

string VxLanConfigSandeshTask::active_
private

Definition at line 457 of file vxlan.cc.

◆ agent_

Agent* VxLanConfigSandeshTask::agent_
private

Definition at line 454 of file vxlan.cc.

◆ context_

string VxLanConfigSandeshTask::context_
private

Definition at line 458 of file vxlan.cc.

◆ vn_

string VxLanConfigSandeshTask::vn_
private

Definition at line 456 of file vxlan.cc.

◆ vxlan_id_

uint32_t VxLanConfigSandeshTask::vxlan_id_
private

Definition at line 455 of file vxlan.cc.


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