FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
VOM::interface_cmds::state_change_cmd Class Reference

A cmd class that changes the admin state. More...

+ Inheritance diagram for VOM::interface_cmds::state_change_cmd:
+ Collaboration diagram for VOM::interface_cmds::state_change_cmd:

Public Member Functions

 state_change_cmd (HW::item< interface::admin_state_t > &s, const HW::item< handle_t > &h)
 Constructor taking the HW::item to update and the name handle of the interface whose state is to change. More...
 
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 state_change_cmd &i) const
 Comparison operator - only used for UT. More...
 
- Public Member Functions inherited from VOM::rpc_cmd< HW::item< interface::admin_state_t >, rc_t, vapi::Sw_interface_set_flags >
 rpc_cmd (HW::item< interface::admin_state_t > &item)
 Constructor taking the HW item that will be updated by the command. More...
 
virtual ~rpc_cmd ()
 Desructor. More...
 
HW::item< interface::admin_state_t > & item ()
 return the HW item the command updates More...
 
const HW::item< interface::admin_state_t > & item () const
 return the const HW item the command updates More...
 
void fulfill (const rc_t &d)
 Fulfill the commands promise. More...
 
rc_t wait ()
 Wait on the commands promise. More...
 
virtual void succeeded ()
 Called by the HW Command Q when it is disabled to indicate the command can be considered successful without issuing it to HW. More...
 
virtual vapi_error_e operator() (vapi::Sw_interface_set_flags &reply)
 call operator used as a callback by VAPI when the reply is available 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::rpc_cmd< HW::item< interface::admin_state_t >, rc_t, vapi::Sw_interface_set_flags >
typedef vapi::Sw_interface_set_flags msg_t
 convenient typedef More...
 
- Protected Attributes inherited from VOM::rpc_cmd< HW::item< interface::admin_state_t >, rc_t, vapi::Sw_interface_set_flags >
HW::item< interface::admin_state_t > & m_hw_item
 A reference to an object's HW::item that the command will update. More...
 
std::promise< rc_tm_promise
 The promise that implements the synchronous issue. More...
 

Detailed Description

A cmd class that changes the admin state.

Definition at line 214 of file interface_cmds.hpp.

Constructor & Destructor Documentation

VOM::interface_cmds::state_change_cmd::state_change_cmd ( HW::item< interface::admin_state_t > &  s,
const HW::item< handle_t > &  h 
)

Constructor taking the HW::item to update and the name handle of the interface whose state is to change.

Definition at line 218 of file interface_cmds.cpp.

Member Function Documentation

rc_t VOM::interface_cmds::state_change_cmd::issue ( connection con)
virtual

Issue the command to VPP/HW.

Implements VOM::cmd.

Definition at line 232 of file interface_cmds.cpp.

+ Here is the call graph for this function:

bool VOM::interface_cmds::state_change_cmd::operator== ( const state_change_cmd i) const

Comparison operator - only used for UT.

Definition at line 226 of file interface_cmds.cpp.

std::string VOM::interface_cmds::state_change_cmd::to_string ( void  ) const
virtual

convert to string format for debug purposes

Implements VOM::cmd.

Definition at line 248 of file interface_cmds.cpp.

+ Here is the call graph for this function:


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