PktSandeshFlow Class Reference

#include <pkt_sandesh_flow.h>

Inheritance diagram for PktSandeshFlow:

Collaboration diagram for PktSandeshFlow:

Public Member Functions
	PktSandeshFlow (Agent *agent, FlowRecordsResp *obj, std::string resp_ctx, std::string key)
virtual	~PktSandeshFlow ()
void	SendResponse (SandeshResponse *resp)
bool	SetFlowKey (std::string key)
virtual bool	Run ()
	Code to execute. Returns true if task is completed. Return false to reschedule the task. More...
std::string	Description () const
void	SetSandeshFlowData (std::vector< SandeshFlowData > &list, FlowEntry *fe, const FlowExportInfo *info)
void	set_delete_op (bool delete_op)
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

Static Public Member Functions
static std::string	GetFlowKey (const FlowKey &key, uint16_t partition_id)
Static Public Member Functions inherited from Task
static Task *	Running ()
	Returns a pointer to the current task the code is executing under. More...

Static Public Attributes
static const int	kMaxFlowResponse = 100
static const char	kDelimiter = '-'
static const std::string	start_key = "0-0-0-0-0-0.0.0.0-0.0.0.0"
Static Public Attributes inherited from Task
static const int	kTaskInstanceAny = -1

Protected Attributes
FlowRecordsResp *	resp_obj_
std::string	resp_data_
FlowKey	flow_iteration_key_
bool	key_valid_
bool	delete_op_
Agent *	agent_
uint16_t	partition_id_

Private Member Functions
	DISALLOW_COPY_AND_ASSIGN (PktSandeshFlow)

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 }

Detailed Description

Definition at line 13 of file pkt_sandesh_flow.h.

Constructor & Destructor Documentation

PktSandeshFlow::PktSandeshFlow	(	Agent *	agent,
		FlowRecordsResp *	obj,
		std::string	resp_ctx,
		std::string	key
	)

Definition at line 282 of file pkt_sandesh_flow.cc.

Here is the call graph for this function:

PktSandeshFlow::~PktSandeshFlow ( )

virtual

Definition at line 295 of file pkt_sandesh_flow.cc.

Member Function Documentation

std::string PktSandeshFlow::Description ( ) const

inlinevirtual

Implements Task.

Definition at line 27 of file pkt_sandesh_flow.h.

PktSandeshFlow::DISALLOW_COPY_AND_ASSIGN ( PktSandeshFlow  )

private

string PktSandeshFlow::GetFlowKey ( const FlowKey &  key, uint16_t  partition_id  )

static

Definition at line 311 of file pkt_sandesh_flow.cc.

bool PktSandeshFlow::Run ( )

virtual

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

Implements Task.

Reimplemented in PktSandeshFlowStats.

Definition at line 368 of file pkt_sandesh_flow.cc.

Here is the call graph for this function:

void PktSandeshFlow::SendResponse

(

SandeshResponse *

resp

)

Definition at line 305 of file pkt_sandesh_flow.cc.

Here is the call graph for this function:

void PktSandeshFlow::set_delete_op ( bool  delete_op )

inline

Definition at line 30 of file pkt_sandesh_flow.h.

bool PktSandeshFlow::SetFlowKey

(

std::string

key

)

Definition at line 323 of file pkt_sandesh_flow.cc.

void PktSandeshFlow::SetSandeshFlowData	(	std::vector< SandeshFlowData > &	list,
		FlowEntry *	fe,
		const FlowExportInfo *	info
	)

Definition at line 298 of file pkt_sandesh_flow.cc.

Member Data Documentation

Agent* PktSandeshFlow::agent_

protected

Definition at line 38 of file pkt_sandesh_flow.h.

bool PktSandeshFlow::delete_op_

protected

Definition at line 37 of file pkt_sandesh_flow.h.

FlowKey PktSandeshFlow::flow_iteration_key_

protected

Definition at line 35 of file pkt_sandesh_flow.h.

const char PktSandeshFlow::kDelimiter = '-'

static

Definition at line 16 of file pkt_sandesh_flow.h.

bool PktSandeshFlow::key_valid_

protected

Definition at line 36 of file pkt_sandesh_flow.h.

const int PktSandeshFlow::kMaxFlowResponse = 100

static

Definition at line 15 of file pkt_sandesh_flow.h.

uint16_t PktSandeshFlow::partition_id_

protected

Definition at line 39 of file pkt_sandesh_flow.h.

std::string PktSandeshFlow::resp_data_

protected

Definition at line 34 of file pkt_sandesh_flow.h.

FlowRecordsResp* PktSandeshFlow::resp_obj_

protected

Definition at line 33 of file pkt_sandesh_flow.h.

const std::string PktSandeshFlow::start_key = "0-0-0-0-0-0.0.0.0-0.0.0.0"

static

Definition at line 17 of file pkt_sandesh_flow.h.

---

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

• pkt_sandesh_flow.h
• pkt_sandesh_flow.cc