OpenSDN source code
MacLearningSandeshResp Class Reference

#include <mac_learning.h>

Inheritance diagram for MacLearningSandeshResp:
Collaboration diagram for MacLearningSandeshResp:

Public Member Functions

 MacLearningSandeshResp (Agent *agent, MacEntryResp *resp, std::string resp_ctx, std::string key, const MacAddress &mac)
 
virtual ~MacLearningSandeshResp ()
 
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...
 

Static Public Attributes

static const uint32_t kMaxResponse = 100
 
static const char kDelimiter = '-'
 
- Static Public Attributes inherited from Task
static const int kTaskInstanceAny = -1
 Specifies value for wildcard (any or *) task data ID. More...
 

Private Member Functions

bool Run ()
 Code to execute in a task. Returns true if task is completed. Return false to reschedule the task. More...
 
bool SetMacKey (string key)
 
void SendResponse (SandeshResponse *resp)
 
const MacLearningPartitionGetPartition ()
 
std::string GetMacKey ()
 
 DISALLOW_COPY_AND_ASSIGN (MacLearningSandeshResp)
 

Private Attributes

Agentagent_
 
MacEntryResp * resp_
 
std::string resp_data_
 
uint32_t partition_id_
 
uint32_t vrf_id_
 
MacAddress mac_
 
bool exact_match_
 
MacAddress user_given_mac_
 

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...
 

Detailed Description

Definition at line 261 of file mac_learning.h.

Constructor & Destructor Documentation

◆ MacLearningSandeshResp()

MacLearningSandeshResp::MacLearningSandeshResp ( Agent agent,
MacEntryResp *  resp,
std::string  resp_ctx,
std::string  key,
const MacAddress mac 
)

Definition at line 325 of file mac_learning.cc.

Here is the call graph for this function:

◆ ~MacLearningSandeshResp()

MacLearningSandeshResp::~MacLearningSandeshResp ( )
virtual

Definition at line 340 of file mac_learning.cc.

Member Function Documentation

◆ Description()

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

Gives a description of the task.

Implements Task.

Definition at line 270 of file mac_learning.h.

◆ DISALLOW_COPY_AND_ASSIGN()

MacLearningSandeshResp::DISALLOW_COPY_AND_ASSIGN ( MacLearningSandeshResp  )
private

◆ GetMacKey()

string MacLearningSandeshResp::GetMacKey ( )
private

Definition at line 369 of file mac_learning.cc.

Here is the call graph for this function:

◆ GetPartition()

const MacLearningPartition * MacLearningSandeshResp::GetPartition ( )
private

Definition at line 379 of file mac_learning.cc.

Here is the call graph for this function:

◆ Run()

bool MacLearningSandeshResp::Run ( )
privatevirtual

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

Implements Task.

Definition at line 390 of file mac_learning.cc.

Here is the call graph for this function:

◆ SendResponse()

void MacLearningSandeshResp::SendResponse ( SandeshResponse resp)
private

Definition at line 477 of file mac_learning.cc.

Here is the call graph for this function:

◆ SetMacKey()

bool MacLearningSandeshResp::SetMacKey ( string  key)
private

Definition at line 343 of file mac_learning.cc.

Here is the call graph for this function:

Member Data Documentation

◆ agent_

Agent* MacLearningSandeshResp::agent_
private

Definition at line 280 of file mac_learning.h.

◆ exact_match_

bool MacLearningSandeshResp::exact_match_
private

Definition at line 286 of file mac_learning.h.

◆ kDelimiter

const char MacLearningSandeshResp::kDelimiter = '-'
static

Definition at line 264 of file mac_learning.h.

◆ kMaxResponse

const uint32_t MacLearningSandeshResp::kMaxResponse = 100
static

Definition at line 263 of file mac_learning.h.

◆ mac_

MacAddress MacLearningSandeshResp::mac_
private

Definition at line 285 of file mac_learning.h.

◆ partition_id_

uint32_t MacLearningSandeshResp::partition_id_
private

Definition at line 283 of file mac_learning.h.

◆ resp_

MacEntryResp* MacLearningSandeshResp::resp_
private

Definition at line 281 of file mac_learning.h.

◆ resp_data_

std::string MacLearningSandeshResp::resp_data_
private

Definition at line 282 of file mac_learning.h.

◆ user_given_mac_

MacAddress MacLearningSandeshResp::user_given_mac_
private

Definition at line 287 of file mac_learning.h.

◆ vrf_id_

uint32_t MacLearningSandeshResp::vrf_id_
private

Definition at line 284 of file mac_learning.h.


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