xorp

IfConfigSetIPHelper Class Reference

Inheritance diagram for IfConfigSetIPHelper:
IfConfigSet

List of all members.

Public Member Functions

 IfConfigSetIPHelper (FeaDataPlaneManager &fea_data_plane_manager)
 Constructor.
virtual ~IfConfigSetIPHelper ()
 Virtual destructor.
virtual int start (string &error_msg)
 Start operation.
virtual int stop (string &error_msg)
 Stop operation.

Private Member Functions

virtual bool is_discard_emulated (const IfTreeInterface &i) const
 Determine if the interface's underlying provider implements discard semantics natively, or if they are emulated through other means.
virtual bool is_unreachable_emulated (const IfTreeInterface &i) const
 Determine if the interface's underlying provider implements unreachable semantics natively, or if they are emulated through other means.
virtual int config_begin (string &error_msg)
 Start the configuration.
virtual int config_end (string &error_msg)
 Complete the configuration.
virtual int config_interface_begin (const IfTreeInterface *pulled_ifp, IfTreeInterface &config_iface, string &error_msg)
 Begin the interface configuration.
virtual int config_interface_end (const IfTreeInterface *pulled_ifp, const IfTreeInterface &config_iface, string &error_msg)
 End the interface configuration.
virtual int config_vif_begin (const IfTreeInterface *pulled_ifp, const IfTreeVif *pulled_vifp, const IfTreeInterface &config_iface, const IfTreeVif &config_vif, string &error_msg)
 Begin the vif configuration.
virtual int config_vif_end (const IfTreeInterface *pulled_ifp, const IfTreeVif *pulled_vifp, const IfTreeInterface &config_iface, const IfTreeVif &config_vif, string &error_msg)
 End the vif configuration.
virtual int config_add_address (const IfTreeInterface *pulled_ifp, const IfTreeVif *pulled_vifp, const IfTreeAddr4 *pulled_addrp, const IfTreeInterface &config_iface, const IfTreeVif &config_vif, const IfTreeAddr4 &config_addr, string &error_msg)
 Add IPv4 address information.
virtual int config_delete_address (const IfTreeInterface *pulled_ifp, const IfTreeVif *pulled_vifp, const IfTreeAddr4 *pulled_addrp, const IfTreeInterface &config_iface, const IfTreeVif &config_vif, const IfTreeAddr4 &config_addr, string &error_msg)
 Delete IPv4 address information.
virtual int config_add_address (const IfTreeInterface *pulled_ifp, const IfTreeVif *pulled_vifp, const IfTreeAddr6 *pulled_addrp, const IfTreeInterface &config_iface, const IfTreeVif &config_vif, const IfTreeAddr6 &config_addr, string &error_msg)
 Add IPv6 address information.
virtual int config_delete_address (const IfTreeInterface *pulled_ifp, const IfTreeVif *pulled_vifp, const IfTreeAddr6 *pulled_addrp, const IfTreeInterface &config_iface, const IfTreeVif &config_vif, const IfTreeAddr6 &config_addr, string &error_msg)
 Delete IPv6 address information.
int set_interface_status (const string &ifname, uint32_t if_index, uint32_t interface_flags, bool is_enabled, string &error_msg)
 Set the interface status.
int add_addr (const string &ifname, const string &vifname, uint32_t if_index, const IPv4 &addr, uint32_t prefix_len, bool is_broadcast, const IPv4 &broadcast_addr, bool is_point_to_point, const IPv4 &endpoint_addr, string &error_msg)
 Add an IPv4 address to an interface/vif.
int delete_addr (const string &ifname, const string &vifname, uint32_t if_index, const IPv4 &addr, uint32_t prefix_len, string &error_msg)
 Delete an IPv4 address from an interface/vif.
int add_addr (const string &ifname, const string &vifname, uint32_t if_index, const IPv6 &addr, uint32_t prefix_len, bool is_point_to_point, const IPv6 &endpoint_addr, string &error_msg)
 Add an IPv6 address to an interface/vif.
int delete_addr (const string &ifname, const string &vifname, uint32_t if_index, const IPv6 &addr, uint32_t prefix_len, string &error_msg)
 Delete an IPv6 address from an interface/vif.

Constructor & Destructor Documentation

IfConfigSetIPHelper::IfConfigSetIPHelper ( FeaDataPlaneManager fea_data_plane_manager)

Constructor.

Parameters:
fea_data_plane_managerthe corresponding data plane manager (FeaDataPlaneManager).

Member Function Documentation

int IfConfigSetIPHelper::add_addr ( const string &  ifname,
const string &  vifname,
uint32_t  if_index,
const IPv4 addr,
uint32_t  prefix_len,
bool  is_broadcast,
const IPv4 broadcast_addr,
bool  is_point_to_point,
const IPv4 endpoint_addr,
string &  error_msg 
) [private]

Add an IPv4 address to an interface/vif.

Parameters:
ifnamethe name of the interface.
vifnamethe name of the vif.
if_indexthe interface/vif index.
addrthe address to add.
prefix_lenthe prefix length.
is_broadcastif true this is a broadcast vif.
broadcast_addrthe broadcast address if this is a broadcast vif.
is_point_to_pointif true, this is a point-to-point vif.
endpoint_addrthe endpoint address if this is a point-to-point vif.
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.
int IfConfigSetIPHelper::add_addr ( const string &  ifname,
const string &  vifname,
uint32_t  if_index,
const IPv6 addr,
uint32_t  prefix_len,
bool  is_point_to_point,
const IPv6 endpoint_addr,
string &  error_msg 
) [private]

Add an IPv6 address to an interface/vif.

Parameters:
ifnamethe name of the interface.
vifnamethe name of the vif.
if_indexthe interface/vif index.
addrthe address to add.
prefix_lenthe prefix length.
is_point_to_pointif true, this is a point-to-point vif.
endpoint_addrthe endpoint address if this is a point-to-point vif.
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.
virtual int IfConfigSetIPHelper::config_add_address ( const IfTreeInterface pulled_ifp,
const IfTreeVif pulled_vifp,
const IfTreeAddr4 pulled_addrp,
const IfTreeInterface config_iface,
const IfTreeVif config_vif,
const IfTreeAddr4 config_addr,
string &  error_msg 
) [private, virtual]

Add IPv4 address information.

If an entry for the same address already exists, is is overwritten with the new information.

Parameters:
pulled_ifppointer to the interface information pulled from the system.
pulled_vifppointer to the vif information pulled from the system.
pulled_addrppointer to the address information pulled from the system.
config_ifacereference to the interface with the information to configure.
config_vifreference to the vif with the information to configure.
config_addrreference to the address with the information to configure.
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implements IfConfigSet.

virtual int IfConfigSetIPHelper::config_add_address ( const IfTreeInterface pulled_ifp,
const IfTreeVif pulled_vifp,
const IfTreeAddr6 pulled_addrp,
const IfTreeInterface config_iface,
const IfTreeVif config_vif,
const IfTreeAddr6 config_addr,
string &  error_msg 
) [private, virtual]

Add IPv6 address information.

If an entry for the same address already exists, is is overwritten with the new information.

Parameters:
pulled_ifppointer to the interface information pulled from the system.
pulled_vifppointer to the vif information pulled from the system.
pulled_addrppointer to the address information pulled from the system.
config_ifacereference to the interface with the information to configure.
config_vifreference to the vif with the information to configure.
config_addrreference to the address with the information to configure.
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implements IfConfigSet.

virtual int IfConfigSetIPHelper::config_begin ( string &  error_msg) [private, virtual]

Start the configuration.

Parameters:
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implements IfConfigSet.

virtual int IfConfigSetIPHelper::config_delete_address ( const IfTreeInterface pulled_ifp,
const IfTreeVif pulled_vifp,
const IfTreeAddr4 pulled_addrp,
const IfTreeInterface config_iface,
const IfTreeVif config_vif,
const IfTreeAddr4 config_addr,
string &  error_msg 
) [private, virtual]

Delete IPv4 address information.

Parameters:
pulled_ifppointer to the interface information pulled from the system.
pulled_vifppointer to the vif information pulled from the system.
pulled_addrppointer to the address information pulled from the system.
config_ifacereference to the interface with the information to configure.
config_vifreference to the vif with the information to configure.
config_addrreference to the address with the information to configure.
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implements IfConfigSet.

virtual int IfConfigSetIPHelper::config_delete_address ( const IfTreeInterface pulled_ifp,
const IfTreeVif pulled_vifp,
const IfTreeAddr6 pulled_addrp,
const IfTreeInterface config_iface,
const IfTreeVif config_vif,
const IfTreeAddr6 config_addr,
string &  error_msg 
) [private, virtual]

Delete IPv6 address information.

Parameters:
pulled_ifppointer to the interface information pulled from the system.
pulled_vifppointer to the vif information pulled from the system.
pulled_addrppointer to the address information pulled from the system.
config_ifacereference to the interface with the information to configure.
config_vifreference to the vif with the information to configure.
config_addrreference to the address with the information to configure.
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implements IfConfigSet.

virtual int IfConfigSetIPHelper::config_end ( string &  error_msg) [private, virtual]

Complete the configuration.

Parameters:
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implements IfConfigSet.

virtual int IfConfigSetIPHelper::config_interface_begin ( const IfTreeInterface pulled_ifp,
IfTreeInterface config_iface,
string &  error_msg 
) [private, virtual]

Begin the interface configuration.

Parameters:
pulled_ifppointer to the interface information pulled from the system.
config_ifacereference to the interface with the information to configure.
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implements IfConfigSet.

virtual int IfConfigSetIPHelper::config_interface_end ( const IfTreeInterface pulled_ifp,
const IfTreeInterface config_iface,
string &  error_msg 
) [private, virtual]

End the interface configuration.

Parameters:
pulled_ifppointer to the interface information pulled from the system.
config_ifacereference to the interface with the information to configure.
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implements IfConfigSet.

virtual int IfConfigSetIPHelper::config_vif_begin ( const IfTreeInterface pulled_ifp,
const IfTreeVif pulled_vifp,
const IfTreeInterface config_iface,
const IfTreeVif config_vif,
string &  error_msg 
) [private, virtual]

Begin the vif configuration.

Parameters:
pulled_ifppointer to the interface information pulled from the system.
pulled_vifppointer to the vif information pulled from the system.
config_ifacereference to the interface with the information to configure.
config_vifreference to the vif with the information to configure.
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implements IfConfigSet.

virtual int IfConfigSetIPHelper::config_vif_end ( const IfTreeInterface pulled_ifp,
const IfTreeVif pulled_vifp,
const IfTreeInterface config_iface,
const IfTreeVif config_vif,
string &  error_msg 
) [private, virtual]

End the vif configuration.

Parameters:
pulled_ifppointer to the interface information pulled from the system.
pulled_vifppointer to the vif information pulled from the system.
config_ifacereference to the interface with the information to configure.
config_vifreference to the vif with the information to configure.
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implements IfConfigSet.

int IfConfigSetIPHelper::delete_addr ( const string &  ifname,
const string &  vifname,
uint32_t  if_index,
const IPv6 addr,
uint32_t  prefix_len,
string &  error_msg 
) [private]

Delete an IPv6 address from an interface/vif.

Parameters:
ifnamethe name of the interface.
vifnamethe name of the vif.
if_indexthe interface/vif index.
addrthe address to delete.
prefix_lenthe prefix length.
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.
int IfConfigSetIPHelper::delete_addr ( const string &  ifname,
const string &  vifname,
uint32_t  if_index,
const IPv4 addr,
uint32_t  prefix_len,
string &  error_msg 
) [private]

Delete an IPv4 address from an interface/vif.

Parameters:
ifnamethe name of the interface.
vifnamethe name of the vif.
if_indexthe interface/vif index.
addrthe address to delete.
prefix_lenthe prefix length.
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.
virtual bool IfConfigSetIPHelper::is_discard_emulated ( const IfTreeInterface i) const [private, virtual]

Determine if the interface's underlying provider implements discard semantics natively, or if they are emulated through other means.

Parameters:
ithe interface item to inspect.
Returns:
true if discard semantics are emulated.

Implements IfConfigSet.

virtual bool IfConfigSetIPHelper::is_unreachable_emulated ( const IfTreeInterface i) const [private, virtual]

Determine if the interface's underlying provider implements unreachable semantics natively, or if they are emulated through other means.

Parameters:
ithe interface item to inspect.
Returns:
true if unreachable semantics are emulated.

Implements IfConfigSet.

int IfConfigSetIPHelper::set_interface_status ( const string &  ifname,
uint32_t  if_index,
uint32_t  interface_flags,
bool  is_enabled,
string &  error_msg 
) [private]

Set the interface status.

Parameters:
ifnamethe name of the interface.
if_indexthe interface index.
interface_flagsthe interface flags.
is_enabledif true then enable the interface, otherwise disable it.
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.
virtual int IfConfigSetIPHelper::start ( string &  error_msg) [virtual]

Start operation.

Parameters:
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implements IfConfigSet.

virtual int IfConfigSetIPHelper::stop ( string &  error_msg) [virtual]

Stop operation.

Parameters:
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implements IfConfigSet.


The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Typedefs Enumerations