FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
VOM::neighbour_cmds::dump_cmd Class Reference

A cmd class that Dumps all the neighbours. More...

+ Inheritance diagram for VOM::neighbour_cmds::dump_cmd:
+ Collaboration diagram for VOM::neighbour_cmds::dump_cmd:

Public Member Functions

 dump_cmd (const handle_t &itf, const l3_proto_t &proto)
 Constructor. More...
 
 dump_cmd (const dump_cmd &d)
 
rc_t issue (connection &con)
 Issue the command to VPP/HW. More...
 
std::string to_string () const
 convert to string format for debug purposes More...
 
bool operator== (const dump_cmd &i) const
 Comparison operator - only used for UT. More...
 
- Public Member Functions inherited from VOM::dump_cmd< vapi::Ip_neighbor_dump >
 dump_cmd ()
 Default Constructor. More...
 
 dump_cmd (const dump_cmd &d)=default
 
virtual ~dump_cmd ()
 Destructor. More...
 
const_iterator begin ()
 Constant iterator to the start of the records retunred during the dump. More...
 
const_iterator end ()
 Constant iterator to the end of the records retunred during the dump. More...
 
rc_t wait ()
 Wait for the issue of the command to complete. More...
 
vapi_error_e operator() (vapi::Ip_neighbor_dump &d)
 Call operator called when the dump is complete. More...
 
virtual void retire (connection &con)
 Retire/cancel a long running command. More...
 
- Public Member Functions inherited from VOM::cmd
 cmd ()
 Default constructor. More...
 
virtual ~cmd ()
 Virtual destructor. More...
 

Additional Inherited Members

- Public Types inherited from VOM::dump_cmd< vapi::Ip_neighbor_dump >
typedef vapi::Ip_neighbor_dump msg_t
 
typedef vapi::Ip_neighbor_dump ::resp_type record_t
 
typedef vapi::Result_set< typename vapi::Ip_neighbor_dump ::resp_type >::const_iterator const_iterator
 
- Protected Member Functions inherited from VOM::dump_cmd< vapi::Ip_neighbor_dump >
void succeeded ()
 Dump commands should not be issued whilst the HW is disabled. More...
 
- Protected Attributes inherited from VOM::dump_cmd< vapi::Ip_neighbor_dump >
std::promise< rc_tm_promise
 The underlying promise that implements the synchornous nature of the command issue. More...
 
std::unique_ptr< vapi::Ip_neighbor_dump > m_dump
 The VAPI event registration. More...
 

Detailed Description

A cmd class that Dumps all the neighbours.

Definition at line 106 of file neighbour_cmds.hpp.

Constructor & Destructor Documentation

◆ dump_cmd() [1/2]

VOM::neighbour_cmds::dump_cmd::dump_cmd ( const handle_t itf,
const l3_proto_t proto 
)

Constructor.

Definition at line 122 of file neighbour_cmds.cpp.

◆ dump_cmd() [2/2]

VOM::neighbour_cmds::dump_cmd::dump_cmd ( const dump_cmd d)

Definition at line 128 of file neighbour_cmds.cpp.

Member Function Documentation

◆ issue()

rc_t VOM::neighbour_cmds::dump_cmd::issue ( connection con)
virtual

Issue the command to VPP/HW.

Implements VOM::cmd.

Definition at line 141 of file neighbour_cmds.cpp.

+ Here is the call graph for this function:

◆ operator==()

bool VOM::neighbour_cmds::dump_cmd::operator== ( const dump_cmd i) const

Comparison operator - only used for UT.

Definition at line 135 of file neighbour_cmds.cpp.

◆ to_string()

std::string VOM::neighbour_cmds::dump_cmd::to_string ( void  ) const
virtual

convert to string format for debug purposes

Implements VOM::cmd.

Definition at line 157 of file neighbour_cmds.cpp.

+ Here is the call graph for this function:

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