XrlVrrpTargetBase Class Reference

Inheritance diagram for XrlVrrpTargetBase:

List of all members.

Classes
struct	handler_table
Public Member Functions
	XrlVrrpTargetBase (XrlCmdMap *cmds=0)
	Constructor.
virtual	~XrlVrrpTargetBase ()
	Destructor.
bool	set_command_map (XrlCmdMap *cmds)
	Set command map.
const string &	get_name () const
	Get Xrl instance name associated with command map.
const char *	version () const
	Get version string of instance.
	XrlVrrpTargetBase (XrlCmdMap *cmds=0)
	Constructor.
virtual	~XrlVrrpTargetBase ()
	Destructor.
bool	set_command_map (XrlCmdMap *cmds)
	Set command map.
const string &	get_name () const
	Get Xrl instance name associated with command map.
const char *	version () const
	Get version string of instance.
Protected Member Functions
virtual XrlCmdError	common_0_1_get_target_name (string &name)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	common_0_1_get_version (string &version)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	common_0_1_get_status (uint32_t &status, string &reason)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	common_0_1_shutdown ()=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	common_0_1_startup ()=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_add_vrid (const string &ifname, const string &vifname, const uint32_t &vrid)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_delete_vrid (const string &ifname, const string &vifname, const uint32_t &vrid)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_set_priority (const string &ifname, const string &vifname, const uint32_t &vrid, const uint32_t &priority)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_set_interval (const string &ifname, const string &vifname, const uint32_t &vrid, const uint32_t &interval)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_set_preempt (const string &ifname, const string &vifname, const uint32_t &vrid, const bool &preempt)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_set_disable (const string &ifname, const string &vifname, const uint32_t &vrid, const bool &disable)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_add_ip (const string &ifname, const string &vifname, const uint32_t &vrid, const IPv4 &ip)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_set_prefix (const string &ifname, const string &vifname, const uint32_t &vrid, const IPv4 &ip, const uint32_t &prefix_len)=0
virtual XrlCmdError	vrrp_0_1_delete_ip (const string &ifname, const string &vifname, const uint32_t &vrid, const IPv4 &ip)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_get_ifs (XrlAtomList &ifs)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_get_vifs (const string &ifname, XrlAtomList &vifs)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_get_vrids (const string &ifname, const string &vifname, XrlAtomList &vrids)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_get_vrid_info (const string &ifname, const string &vifname, const uint32_t &vrid, string &state, IPv4 &master)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	raw_packet4_client_0_1_recv (const string &if_name, const string &vif_name, const IPv4 &src_address, const IPv4 &dst_address, const uint32_t &ip_protocol, const int32_t &ip_ttl, const int32_t &ip_tos, const bool &ip_router_alert, const bool &ip_internet_control, const vector< uint8_t > &payload)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	raw_link_client_0_1_recv (const string &if_name, const string &vif_name, const Mac &src_address, const Mac &dst_address, const uint32_t &ether_type, const vector< uint8_t > &payload)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	common_0_1_get_target_name (string &name)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	common_0_1_get_version (string &version)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	common_0_1_get_status (uint32_t &status, string &reason)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	common_0_1_shutdown ()=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	common_0_1_startup ()=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_add_vrid (const string &ifname, const string &vifname, const uint32_t &vrid)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_delete_vrid (const string &ifname, const string &vifname, const uint32_t &vrid)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_set_priority (const string &ifname, const string &vifname, const uint32_t &vrid, const uint32_t &priority)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_set_interval (const string &ifname, const string &vifname, const uint32_t &vrid, const uint32_t &interval)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_set_preempt (const string &ifname, const string &vifname, const uint32_t &vrid, const bool &preempt)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_set_disable (const string &ifname, const string &vifname, const uint32_t &vrid, const bool &disable)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_add_ip (const string &ifname, const string &vifname, const uint32_t &vrid, const IPv4 &ip)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_set_prefix (const string &ifname, const string &vifname, const uint32_t &vrid, const IPv4 &ip, const uint32_t &prefix_len)=0
virtual XrlCmdError	vrrp_0_1_delete_ip (const string &ifname, const string &vifname, const uint32_t &vrid, const IPv4 &ip)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_get_ifs (XrlAtomList &ifs)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_get_vifs (const string &ifname, XrlAtomList &vifs)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_get_vrids (const string &ifname, const string &vifname, XrlAtomList &vrids)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	vrrp_0_1_get_vrid_info (const string &ifname, const string &vifname, const uint32_t &vrid, string &state, IPv4 &master)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	raw_packet4_client_0_1_recv (const string &if_name, const string &vif_name, const IPv4 &src_address, const IPv4 &dst_address, const uint32_t &ip_protocol, const int32_t &ip_ttl, const int32_t &ip_tos, const bool &ip_router_alert, const bool &ip_internet_control, const vector< uint8_t > &payload)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	raw_link_client_0_1_recv (const string &if_name, const string &vif_name, const Mac &src_address, const Mac &dst_address, const uint32_t &ether_type, const vector< uint8_t > &payload)=0
	Pure-virtual function that needs to be implemented to:
Protected Attributes
XrlCmdMap *	_cmds
Private Member Functions
XrlCmdRT	handle_common_0_1_get_target_name (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_common_0_1_get_version (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_common_0_1_get_status (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_common_0_1_shutdown (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_common_0_1_startup (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_add_vrid (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_delete_vrid (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_set_priority (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_set_interval (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_set_preempt (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_set_disable (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_add_ip (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_set_prefix (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_delete_ip (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_get_ifs (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_get_vifs (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_get_vrids (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_get_vrid_info (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_raw_packet4_client_0_1_recv (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_raw_link_client_0_1_recv (const XrlArgs &in, XrlCmdOT out)
void	add_handlers ()
void	remove_handlers ()
XrlCmdRT	handle_common_0_1_get_target_name (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_common_0_1_get_version (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_common_0_1_get_status (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_common_0_1_shutdown (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_common_0_1_startup (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_add_vrid (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_delete_vrid (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_set_priority (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_set_interval (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_set_preempt (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_set_disable (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_add_ip (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_set_prefix (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_delete_ip (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_get_ifs (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_get_vifs (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_get_vrids (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_vrrp_0_1_get_vrid_info (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_raw_packet4_client_0_1_recv (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_raw_link_client_0_1_recv (const XrlArgs &in, XrlCmdOT out)
void	add_handlers ()
void	remove_handlers ()
Static Private Attributes
static struct handler_table	handlers []
static const size_t	num_handlers = (sizeof(XrlVrrpTargetBase::handlers) / sizeof(XrlVrrpTargetBase::handlers[0]))

---

Constructor & Destructor Documentation

XrlVrrpTargetBase::XrlVrrpTargetBase

(

XrlCmdMap *

cmds = 0

)

Constructor.

Parameters:

cmds	an XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.

XrlVrrpTargetBase::~XrlVrrpTargetBase

(

)

[virtual]

Destructor.

Dissociates instance commands from command map.

XrlVrrpTargetBase::XrlVrrpTargetBase

(

XrlCmdMap *

cmds = 0

)

Constructor.

Parameters:

cmds	an XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.

virtual XrlVrrpTargetBase::~XrlVrrpTargetBase

(

)

[virtual]

Destructor.

Dissociates instance commands from command map.

---

Member Function Documentation

virtual XrlCmdError XrlVrrpTargetBase::common_0_1_get_status	(	uint32_t &	status,
		string &	reason
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::common_0_1_get_status	(	uint32_t &	status,
		string &	reason
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::common_0_1_get_target_name

(

string &

name

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::common_0_1_get_target_name

(

string &

name

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::common_0_1_get_version

(

string &

version

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::common_0_1_get_version

(

string &

version

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::common_0_1_shutdown

(

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::common_0_1_shutdown

(

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::common_0_1_startup

(

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::common_0_1_startup

(

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::raw_link_client_0_1_recv	(	const string &	if_name,
		const string &	vif_name,
		const Mac &	src_address,
		const Mac &	dst_address,
		const uint32_t &	ether_type,
		const vector< uint8_t > &	payload
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Receive a raw link-level packet on an interface.

Parameters:

if_name	the interface name the packet arrived on.
vif_name	the vif name the packet arrived on.
src_address	the MAC source address.
dst_address	the MAC destination address.
ether_type	the EtherType protocol number or the Destination SAP. It must be between 1536 and 65535 to specify the EtherType, or between 1 and 255 to specify the Destination SAP for IEEE 802.2 LLC frames.
payload	the payload, everything after the MAC header.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::raw_link_client_0_1_recv	(	const string &	if_name,
		const string &	vif_name,
		const Mac &	src_address,
		const Mac &	dst_address,
		const uint32_t &	ether_type,
		const vector< uint8_t > &	payload
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Receive a raw link-level packet on an interface.

Parameters:

if_name	the interface name the packet arrived on.
vif_name	the vif name the packet arrived on.
src_address	the MAC source address.
dst_address	the MAC destination address.
ether_type	the EtherType protocol number or the Destination SAP. It must be between 1536 and 65535 to specify the EtherType, or between 1 and 255 to specify the Destination SAP for IEEE 802.2 LLC frames.
payload	the payload, everything after the MAC header.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::raw_packet4_client_0_1_recv	(	const string &	if_name,
		const string &	vif_name,
		const IPv4 &	src_address,
		const IPv4 &	dst_address,
		const uint32_t &	ip_protocol,
		const int32_t &	ip_ttl,
		const int32_t &	ip_tos,
		const bool &	ip_router_alert,
		const bool &	ip_internet_control,
		const vector< uint8_t > &	payload
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Receive an IPv4 packet from a raw socket.

Parameters:

if_name	the interface name the packet arrived on.
vif_name	the vif name the packet arrived on.
src_address	the IP source address.
dst_address	the IP destination address.
ip_protocol	the IP protocol number.
ip_ttl	the IP TTL (hop-limit). If it has a negative value, then the received value is unknown.
ip_tos	the Type of Service (Diffserv/ECN bits for IPv4). If it has a negative value, then the received value is unknown.
ip_router_alert	if true, the IP Router Alert option was included in the IP packet.
ip_internet_control	if true, then this is IP control traffic.
payload	the payload, everything after the IP header and options.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::raw_packet4_client_0_1_recv	(	const string &	if_name,
		const string &	vif_name,
		const IPv4 &	src_address,
		const IPv4 &	dst_address,
		const uint32_t &	ip_protocol,
		const int32_t &	ip_ttl,
		const int32_t &	ip_tos,
		const bool &	ip_router_alert,
		const bool &	ip_internet_control,
		const vector< uint8_t > &	payload
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Receive an IPv4 packet from a raw socket.

Parameters:

if_name	the interface name the packet arrived on.
vif_name	the vif name the packet arrived on.
src_address	the IP source address.
dst_address	the IP destination address.
ip_protocol	the IP protocol number.
ip_ttl	the IP TTL (hop-limit). If it has a negative value, then the received value is unknown.
ip_tos	the Type of Service (Diffserv/ECN bits for IPv4). If it has a negative value, then the received value is unknown.
ip_router_alert	if true, the IP Router Alert option was included in the IP packet.
ip_internet_control	if true, then this is IP control traffic.
payload	the payload, everything after the IP header and options.

Implemented in VrrpTarget.

bool XrlVrrpTargetBase::set_command_map

(

XrlCmdMap *

cmds

)

Set command map.

Parameters:

cmds	pointer to command map to associate commands with. This argument is typically a pointer to the XrlRouter associated with the target.

Returns:

true on success, false if cmds is null or a command map has already been supplied.

bool XrlVrrpTargetBase::set_command_map

(

XrlCmdMap *

cmds

)

Set command map.

Parameters:

cmds	pointer to command map to associate commands with. This argument is typically a pointer to the XrlRouter associated with the target.

Returns:

true on success, false if cmds is null or a command map has already been supplied.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_add_ip	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid,
		const IPv4 &	ip
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add an IP to the virtual router.

Parameters:

ifname	the interface on which VRRP is running.
vifname	the vif on which VRRP is running.
vrid	the VRRP router ID.
ip	the IP address to add.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_add_ip	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid,
		const IPv4 &	ip
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add an IP to the virtual router.

Parameters:

ifname	the interface on which VRRP is running.
vifname	the vif on which VRRP is running.
vrid	the VRRP router ID.
ip	the IP address to add.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_add_vrid	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Create a VRRP instance.

Parameters:

ifname	the interface name.
vifname	the vif name.
vrid	the VRRP router ID.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_add_vrid	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Create a VRRP instance.

Parameters:

ifname	the interface name.
vifname	the vif name.
vrid	the VRRP router ID.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_delete_ip	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid,
		const IPv4 &	ip
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Remove an IP from the virtual router.

Parameters:

ifname	the interface on which VRRP is running.
vifname	the vif on which VRRP is running.
vrid	the VRRP router ID.
ip	the IP address to remove.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_delete_ip	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid,
		const IPv4 &	ip
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Remove an IP from the virtual router.

Parameters:

ifname	the interface on which VRRP is running.
vifname	the vif on which VRRP is running.
vrid	the VRRP router ID.
ip	the IP address to remove.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_delete_vrid	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Remove a VRRP instance.

Parameters:

ifname	the interface name.
vifname	the vif name.
vrid	the VRRP router ID.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_delete_vrid	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Remove a VRRP instance.

Parameters:

ifname	the interface name.
vifname	the vif name.
vrid	the VRRP router ID.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_get_ifs

(

XrlAtomList &

ifs

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get the physical interfaces on which VRRP is running.

Parameters:

ifs	a list of interface names (strings).

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_get_ifs

(

XrlAtomList &

ifs

)

[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get the physical interfaces on which VRRP is running.

Parameters:

ifs	a list of interface names (strings).

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_get_vifs	(	const string &	ifname,
		XrlAtomList &	vifs
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

For a given physical interface, get the virtual interfaces on which VRRP is running.

Parameters:

ifname	the physical interface name.
vifs	a list of virtual interface names (strings).

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_get_vifs	(	const string &	ifname,
		XrlAtomList &	vifs
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

For a given physical interface, get the virtual interfaces on which VRRP is running.

Parameters:

ifname	the physical interface name.
vifs	a list of virtual interface names (strings).

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_get_vrid_info	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid,
		string &	state,
		IPv4 &	master
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get state information from a particular VRRP instance.

Parameters:

ifname	the interface on which the VRRP instance is running.
vifname	the vif on which the instance is running.
vrid	the virtual router ID of the VRRP instance.
state	the state of the router (initialize, master, backup).
master	the IP address of the master. Only valid when running.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_get_vrid_info	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid,
		string &	state,
		IPv4 &	master
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get state information from a particular VRRP instance.

Parameters:

ifname	the interface on which the VRRP instance is running.
vifname	the vif on which the instance is running.
vrid	the virtual router ID of the VRRP instance.
state	the state of the router (initialize, master, backup).
master	the IP address of the master. Only valid when running.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_get_vrids	(	const string &	ifname,
		const string &	vifname,
		XrlAtomList &	vrids
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get the virtual router IDs of all the VRRP instances running on a network interface.

Parameters:

ifname	the physical interface name.
vifname	the logical interface name.
vrids	a list of VRRP router IDs (integers).

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_get_vrids	(	const string &	ifname,
		const string &	vifname,
		XrlAtomList &	vrids
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get the virtual router IDs of all the VRRP instances running on a network interface.

Parameters:

ifname	the physical interface name.
vifname	the logical interface name.
vrids	a list of VRRP router IDs (integers).

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_set_disable	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid,
		const bool &	disable
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Start or stop a VRRP instance.

Parameters:

ifname	the interface on which VRRP is running.
vifname	the vif on which VRRP is running.
vrid	the VRRP router ID.
disable	if true, stop VRRP. Start it otherwise.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_set_disable	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid,
		const bool &	disable
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Start or stop a VRRP instance.

Parameters:

ifname	the interface on which VRRP is running.
vifname	the vif on which VRRP is running.
vrid	the VRRP router ID.
disable	if true, stop VRRP. Start it otherwise.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_set_interval	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid,
		const uint32_t &	interval
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set the advertisement interval.

Parameters:

ifname	the interface on which VRRP is running.
vifname	the vif on which VRRP is running.
vrid	the VRRP router ID.
interval	the new advertisement interval.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_set_interval	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid,
		const uint32_t &	interval
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set the advertisement interval.

Parameters:

ifname	the interface on which VRRP is running.
vifname	the vif on which VRRP is running.
vrid	the VRRP router ID.
interval	the new advertisement interval.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_set_preempt	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid,
		const bool &	preempt
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set whether a high priority backup router should preempt a low priority router that is acting as a master.

Parameters:

ifname	the interface on which VRRP is running.
vifname	the vif on which VRRP is running.
vrid	the VRRP router ID.
preempt	true if preemption should occur.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_set_preempt	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid,
		const bool &	preempt
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set whether a high priority backup router should preempt a low priority router that is acting as a master.

Parameters:

ifname	the interface on which VRRP is running.
vifname	the vif on which VRRP is running.
vrid	the VRRP router ID.
preempt	true if preemption should occur.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_set_priority	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid,
		const uint32_t &	priority
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set the router's priority.

Parameters:

ifname	the interface on which VRRP is running.
vifname	the vif on which VRRP is running.
vrid	the VRRP router ID.
priority	the new priority value.

Implemented in VrrpTarget.

virtual XrlCmdError XrlVrrpTargetBase::vrrp_0_1_set_priority	(	const string &	ifname,
		const string &	vifname,
		const uint32_t &	vrid,
		const uint32_t &	priority
	)		[protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set the router's priority.

Parameters:

ifname	the interface on which VRRP is running.
vifname	the vif on which VRRP is running.
vrid	the VRRP router ID.
priority	the new priority value.

Implemented in VrrpTarget.

---

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

• /home/greearb/git/xorp.ct.github/xorp/obj/i386-pc-mingw32/xrl/targets/vrrp_base.cc
• /home/greearb/git/xorp.ct.github/xorp/obj/i386-pc-mingw32/xrl/targets/vrrp_base.hh
• /home/greearb/git/xorp.ct.github/xorp/obj/i686-pc-linux-gnu/xrl/targets/vrrp_base.hh
• /home/greearb/git/xorp.ct.github/xorp/obj/i686-pc-linux-gnu/xrl/targets/vrrp_base.cc