FD.io VPP  v18.07.1-13-g909ba93
Vector Packet Processing
VOM::ACL::list_cmds::update_cmd< RULE, UPDATE > Class Template Reference

A command class that Create the list. More...

+ Inheritance diagram for VOM::ACL::list_cmds::update_cmd< RULE, UPDATE >:
+ Collaboration diagram for VOM::ACL::list_cmds::update_cmd< RULE, UPDATE >:

Public Types

typedef list< RULE >::rules_t cmd_rules_t
 
typedef list< RULE >::key_t cmd_key_t
 
- Public Types inherited from VOM::rpc_cmd< HW::item< handle_t >, UPDATE >
typedef UPDATE msg_t
 convenient typedef More...
 

Public Member Functions

 update_cmd (HW::item< handle_t > &item, const cmd_key_t &key, const cmd_rules_t &rules)
 Constructor. 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 update_cmd &other) const
 Comparison operator - only used for UT. More...
 
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() (UPDATE &reply)
 A callback function for handling ACL creates. More...
 
- Public Member Functions inherited from VOM::rpc_cmd< HW::item< handle_t >, UPDATE >
 rpc_cmd (HW::item< handle_t > &item)
 Constructor taking the HW item that will be updated by the command. More...
 
virtual ~rpc_cmd ()
 Desructor. More...
 
HW::item< handle_t > & item ()
 return the HW item the command updates More...
 
const HW::item< handle_t > & item () const
 return the const HW item the command updates More...
 
void fulfill (const HW::item< handle_t > &d)
 Fulfill the commands promise. More...
 
rc_t wait ()
 Wait on the commands promise. 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

- Protected Attributes inherited from VOM::rpc_cmd< HW::item< handle_t >, UPDATE >
HW::item< handle_t > & m_hw_item
 A reference to an object's HW::item that the command will update. More...
 
std::promise< HW::item< handle_t > > m_promise
 The promise that implements the synchronous issue. More...
 

Detailed Description

template<typename RULE, typename UPDATE>
class VOM::ACL::list_cmds::update_cmd< RULE, UPDATE >

A command class that Create the list.

Definition at line 32 of file acl_list_cmds.hpp.

Member Typedef Documentation

template<typename RULE , typename UPDATE >
typedef list<RULE>::key_t VOM::ACL::list_cmds::update_cmd< RULE, UPDATE >::cmd_key_t

Definition at line 36 of file acl_list_cmds.hpp.

template<typename RULE , typename UPDATE >
typedef list<RULE>::rules_t VOM::ACL::list_cmds::update_cmd< RULE, UPDATE >::cmd_rules_t

Definition at line 35 of file acl_list_cmds.hpp.

Constructor & Destructor Documentation

template<typename RULE , typename UPDATE >
VOM::ACL::list_cmds::update_cmd< RULE, UPDATE >::update_cmd ( HW::item< handle_t > &  item,
const cmd_key_t key,
const cmd_rules_t rules 
)
inline

Constructor.

Definition at line 41 of file acl_list_cmds.hpp.

+ Here is the call graph for this function:

Member Function Documentation

rc_t VOM::ACL::list_cmds::l2_update_cmd::issue ( connection con)
virtual

Issue the command to VPP/HW.

Implements VOM::cmd.

Definition at line 55 of file acl_list_cmds.cpp.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

template<typename RULE , typename UPDATE >
virtual vapi_error_e VOM::ACL::list_cmds::update_cmd< RULE, UPDATE >::operator() ( UPDATE &  reply)
inlinevirtual

A callback function for handling ACL creates.

Reimplemented from VOM::rpc_cmd< HW::item< handle_t >, UPDATE >.

Definition at line 87 of file acl_list_cmds.hpp.

+ Here is the call graph for this function:

template<typename RULE , typename UPDATE >
bool VOM::ACL::list_cmds::update_cmd< RULE, UPDATE >::operator== ( const update_cmd< RULE, UPDATE > &  other) const
inline

Comparison operator - only used for UT.

Definition at line 73 of file acl_list_cmds.hpp.

template<typename RULE , typename UPDATE >
void VOM::ACL::list_cmds::update_cmd< RULE, UPDATE >::succeeded ( )
inlinevirtual

Called by the HW Command Q when it is disabled to indicate the command can be considered successful without issuing it to HW.

Reimplemented from VOM::rpc_cmd< HW::item< handle_t >, UPDATE >.

Definition at line 78 of file acl_list_cmds.hpp.

+ Here is the call graph for this function:

template<typename RULE , typename UPDATE >
std::string VOM::ACL::list_cmds::update_cmd< RULE, UPDATE >::to_string ( void  ) const
inlinevirtual

convert to string format for debug purposes

Implements VOM::cmd.

Definition at line 58 of file acl_list_cmds.hpp.

+ 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: