OpenSDN source code
IFMapServer::IFMapVmSubscribe Class Reference
Inheritance diagram for IFMapServer::IFMapVmSubscribe:
Collaboration diagram for IFMapServer::IFMapVmSubscribe:

Public Member Functions

 IFMapVmSubscribe (DB *db, DBGraph *graph, IFMapServer *server, const std::string &vr_name, const std::string &vm_uuid, bool subscribe, bool has_vms)
 
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 Attributes

DBdb_
 
IFMapServerifmap_server_
 
std::string vr_name_
 
std::string vm_uuid_
 
bool subscribe_
 
bool has_vms_
 

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 135 of file ifmap_server.cc.

Constructor & Destructor Documentation

◆ IFMapVmSubscribe()

IFMapServer::IFMapVmSubscribe::IFMapVmSubscribe ( DB db,
DBGraph graph,
IFMapServer server,
const std::string &  vr_name,
const std::string &  vm_uuid,
bool  subscribe,
bool  has_vms 
)
inline

Definition at line 137 of file ifmap_server.cc.

Member Function Documentation

◆ Description()

std::string IFMapServer::IFMapVmSubscribe::Description ( ) const
inlinevirtual

Gives a description of the task.

Implements Task.

Definition at line 182 of file ifmap_server.cc.

◆ Run()

bool IFMapServer::IFMapVmSubscribe::Run ( )
inlinevirtual

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

Implements Task.

Definition at line 145 of file ifmap_server.cc.

Here is the call graph for this function:

Member Data Documentation

◆ db_

DB* IFMapServer::IFMapVmSubscribe::db_
private

Definition at line 185 of file ifmap_server.cc.

◆ has_vms_

bool IFMapServer::IFMapVmSubscribe::has_vms_
private

Definition at line 190 of file ifmap_server.cc.

◆ ifmap_server_

IFMapServer* IFMapServer::IFMapVmSubscribe::ifmap_server_
private

Definition at line 186 of file ifmap_server.cc.

◆ subscribe_

bool IFMapServer::IFMapVmSubscribe::subscribe_
private

Definition at line 189 of file ifmap_server.cc.

◆ vm_uuid_

std::string IFMapServer::IFMapVmSubscribe::vm_uuid_
private

Definition at line 188 of file ifmap_server.cc.

◆ vr_name_

std::string IFMapServer::IFMapVmSubscribe::vr_name_
private

Definition at line 187 of file ifmap_server.cc.


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