FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
VOM::stat_client Class Reference

A representation of a stat client in VPP. More...

Data Structures

struct  stat_data_t
 stat data representation More...
 

Public Types

typedef std::vector< stat_data_tstat_data_vec_t
 vector of stat_data_t More...
 

Public Member Functions

 stat_client (std::string &socket_name)
 Stat Client constructor with custom socket name. More...
 
 stat_client (std::vector< std::string > &pattern)
 Stat Client constructor with custom vector of patterns. More...
 
 stat_client (std::string socket_name, std::vector< std::string > patterns)
 Stat Client constructor with custom socket name and vector of patterns. More...
 
 stat_client ()
 Stat Client constructor. More...
 
 ~stat_client ()
 Stat Client destructor. More...
 
 stat_client (const stat_client &o)
 Stat Client copy constructor. More...
 
int connect ()
 Connect to stat segment. More...
 
void disconnect ()
 Disconnect to stat segment. More...
 
const stat_data_vec_tdump ()
 dump all the stats for given pattern More...
 
const stat_data_vec_tdump_entry (uint32_t index)
 dump stats for given index in stat directory More...
 
int vec_len (void *vec)
 Get vector length of VPP style vector. More...
 
double heartbeat ()
 
std::string index_to_name (uint32_t index)
 get index to name of stat More...
 

Detailed Description

A representation of a stat client in VPP.

Definition at line 32 of file stat_client.hpp.

Member Typedef Documentation

◆ stat_data_vec_t

vector of stat_data_t

Definition at line 89 of file stat_client.hpp.

Constructor & Destructor Documentation

◆ stat_client() [1/5]

VOM::stat_client::stat_client ( std::string &  socket_name)

Stat Client constructor with custom socket name.

Definition at line 82 of file stat_client.cpp.

◆ stat_client() [2/5]

VOM::stat_client::stat_client ( std::vector< std::string > &  pattern)

Stat Client constructor with custom vector of patterns.

Definition at line 93 of file stat_client.cpp.

◆ stat_client() [3/5]

VOM::stat_client::stat_client ( std::string  socket_name,
std::vector< std::string >  patterns 
)

Stat Client constructor with custom socket name and vector of patterns.

Definition at line 102 of file stat_client.cpp.

◆ stat_client() [4/5]

VOM::stat_client::stat_client ( )

Stat Client constructor.

Definition at line 112 of file stat_client.cpp.

◆ ~stat_client()

VOM::stat_client::~stat_client ( )

Stat Client destructor.

Definition at line 123 of file stat_client.cpp.

+ Here is the call graph for this function:

◆ stat_client() [5/5]

VOM::stat_client::stat_client ( const stat_client o)

Stat Client copy constructor.

Definition at line 131 of file stat_client.cpp.

Member Function Documentation

◆ connect()

int VOM::stat_client::connect ( )

Connect to stat segment.

Definition at line 137 of file stat_client.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ disconnect()

void VOM::stat_client::disconnect ( )

Disconnect to stat segment.

Definition at line 147 of file stat_client.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ dump()

const stat_client::stat_data_vec_t & VOM::stat_client::dump ( )

dump all the stats for given pattern

Definition at line 178 of file stat_client.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ dump_entry()

const stat_client::stat_data_vec_t & VOM::stat_client::dump_entry ( uint32_t  index)

dump stats for given index in stat directory

Definition at line 200 of file stat_client.cpp.

+ Here is the call graph for this function:

◆ heartbeat()

double VOM::stat_client::heartbeat ( )

Definition at line 228 of file stat_client.cpp.

+ Here is the call graph for this function:

◆ index_to_name()

std::string VOM::stat_client::index_to_name ( uint32_t  index)

get index to name of stat

Definition at line 234 of file stat_client.cpp.

+ Here is the call graph for this function:

◆ vec_len()

int VOM::stat_client::vec_len ( void *  vec)

Get vector length of VPP style vector.

Definition at line 155 of file stat_client.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

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