XrlIO< A > Class Template Reference

Concrete implementation of IO using XRLs. More...

#include <xrl_io.hh>

Inheritance diagram for XrlIO< A >:

List of all members.

Public Member Functions
	XrlIO (EventLoop &eventloop, XrlRouter &xrl_router, const string &feaname, const string &ribname)
	Construct an XrlIO instance.
	~XrlIO ()
	Destroy an XrlIO instance.
int	startup ()
	Startup operation.
int	shutdown ()
	Shutdown operation.
void	component_up (string name)
	Called when internal subsystem comes up.
void	component_down (string name)
	Called when internal subsystem goes down.
void	receive (const string &sockid, const string &interface, const string &vif, const IPv4 &src, const uint16_t &sport, const vector< uint8_t > &payload)
	Receive UDP datagrams.
bool	send (const string &interface, const string &vif, const IPv4 &src, const uint16_t &sport, const IPv4 &dst, const uint16_t &dport, uint8_t *data, const uint32_t &len)
	Send a UDP datagram on a specific link.
bool	enable_interface_vif (const string &interface, const string &vif)
	Enable the interface/vif to receive frames.
bool	disable_interface_vif (const string &interface, const string &vif)
	Disable this interface/vif from receiving frames.
bool	enable_address (const string &interface, const string &vif, const IPv4 &address, const uint16_t &port, const IPv4 &all_nodes_address)
	Enable an IPv4 address and port for OLSR datagram reception and transmission.
bool	disable_address (const string &interface, const string &vif, const IPv4 &address, const uint16_t &port)
	Disable an IPv4 address and port for OLSR datagram reception.
bool	is_interface_enabled (const string &interface) const
	Test whether an interface is enabled.
bool	is_vif_enabled (const string &interface, const string &vif) const
	Test whether an interface/vif is enabled.
bool	is_vif_broadcast_capable (const string &interface, const string &vif)
	Test whether this interface/vif is broadcast capable.
bool	is_vif_multicast_capable (const string &interface, const string &vif)
	Test whether this interface/vif is multicast capable.
bool	is_vif_loopback (const string &interface, const string &vif)
	Return true if the given vif is a loopback vif.
bool	is_address_enabled (const string &interface, const string &vif, const IPv4 &address) const
	Test whether an interface/vif/address is enabled.
bool	get_addresses (const string &interface, const string &vif, list< IPv4 > &addresses) const
	Get all addresses associated with this interface/vif.
bool	get_broadcast_address (const string &interface, const string &vif, IPv4 &address) const
	Get the broadcast address associated with this vif.
bool	get_broadcast_address (const string &interface, const string &vif, const IPv4 &address, IPv4 &bcast_address) const
	Get the broadcast address associated with this IPv4 address.
bool	get_interface_id (const string &interface, uint32_t &interface_id)
	Get the interface ID.
uint32_t	get_prefix_length (const string &interface, const string &vif, IPv4 address)
	Obtain the subnet prefix length for an interface/vif/address.
uint32_t	get_mtu (const string &interface)
	Obtain the MTU for an interface.
void	register_rib ()
	Register with the RIB.
void	unregister_rib ()
	Remove registration from the RIB.
void	rib_command_done (const XrlError &error, bool up, const char *comment)
	Callback method to: signal that an XRL command which has been sent to the RIB has returned.
bool	add_route (IPv4Net net, IPv4 nexthop, uint32_t nexthop_id, uint32_t metric, const PolicyTags &policytags)
	Add route to RIB.
bool	replace_route (IPv4Net net, IPv4 nexthop, uint32_t nexthop_id, uint32_t metric, const PolicyTags &policytags)
	Replace route in RIB.
bool	delete_route (IPv4Net net)
	Delete route from RIB.
	XrlIO (EventLoop &eventloop, XrlRouter &xrl_router, const string &feaname, const string &ribname)
int	startup ()
	Startup operation.
int	shutdown ()
	Shutdown operation.
void	component_up (string)
	Called when internal subsystem comes up.
void	component_down (string)
	Called when internal subsystem goes down.
void	recv (const string &interface, const string &vif, A src, A dst, uint8_t ip_protocol, int32_t ip_ttl, int32_t ip_tos, bool ip_router_alert, bool ip_internet_control, const vector< uint8_t > &payload)
	Receiver Raw frames.
bool	send (const string &interface, const string &vif, A dst, A src, int ttl, uint8_t *data, uint32_t len)
	Send Raw frames.
bool	enable_interface_vif (const string &interface, const string &vif)
	Enable the interface/vif to receive frames.
bool	disable_interface_vif (const string &interface, const string &vif)
	Disable this interface/vif from receiving frames.
bool	is_interface_enabled (const string &interface) const
	Test whether an interface is enabled.
bool	is_vif_enabled (const string &interface, const string &vif) const
	Test whether an interface/vif is enabled.
bool	is_address_enabled (const string &interface, const string &vif, const A &address) const
	Test whether an interface/vif/address is enabled.
bool	get_addresses (const string &interface, const string &vif, list< A > &addresses) const
	Get all addresses associated with this interface/vif.
bool	get_link_local_address (const string &interface, const string &vif, A &address)
	Get a link local address for this interface/vif if available.
bool	get_interface_id (const string &interface, uint32_t &interface_id)
	Get the interface ID.
uint32_t	get_prefix_length (const string &interface, const string &vif, A address)
	Obtain the subnet prefix length for an interface/vif/address.
uint32_t	get_mtu (const string &interface)
	Obtain the MTU for an interface.
bool	join_multicast_group (const string &interface, const string &vif, A mcast)
	On the interface/vif join this multicast group.
bool	leave_multicast_group (const string &interface, const string &vif, A mcast)
	On the interface/vif leave this multicast group.
void	register_rib ()
	Register with the RIB.
void	unregister_rib ()
	Remove registration from the RIB.
void	rib_command_done (const XrlError &error, bool up, const char *comment)
bool	add_route (IPNet< A > net, A nexthop, uint32_t nexthop_id, uint32_t metric, bool equal, bool discard, const PolicyTags &policytags)
	Add route to RIB.
bool	replace_route (IPNet< A > net, A nexthop, uint32_t nexthop_id, uint32_t metric, bool equal, bool discard, const PolicyTags &policytags)
	Replace route in RIB.
bool	delete_route (IPNet< A > net)
	Delete route from RIB.
Private Member Functions
void	status_change (ServiceBase *service, ServiceStatus old_status, ServiceStatus new_status)
	A method invoked when the status of a service changes.
const ServiceBase *	ifmgr_mirror_service_base () const
const IfMgrIfTree &	ifmgr_iftree () const
void	tree_complete ()
	An IfMgrHintObserver method invoked when the initial interface tree information has been received.
void	updates_made ()
	An IfMgrHintObserver method invoked whenever the interface tree information has been changed.
void	send_cb (const XrlError &xrl_error)
	Callback method to: signal that the XRL command to send a UDP datagram has returned.
XrlPort *	find_port (const string &ifname, const string &vifname, const IPv4 &addr)
	Find OLSR port associated with interface, vif, address tuple.
const XrlPort *	find_port (const string &ifname, const string &vifname, const IPv4 &addr) const
	Find OLSR port associated with interface, vif, address tuple.
XrlPortList &	ports ()
const XrlPortList &	ports () const
void	try_start_next_port ()
	Gradually start each XrlPort to avoid races with the FEA.
void	status_change (ServiceBase *service, ServiceStatus old_status, ServiceStatus new_status)
	A method invoked when the status of a service changes.
const ServiceBase *	ifmgr_mirror_service_base () const
	Obtain a pointer to the interface manager service base.
const IfMgrIfTree &	ifmgr_iftree () const
	Obtain a reference to the interface manager's interface tree.
void	tree_complete ()
	An IfMgrHintObserver method invoked when the initial interface tree information has been received.
void	updates_made ()
	An IfMgrHintObserver method invoked whenever the interface tree information has been changed.
void	send_cb (const XrlError &xrl_error, string interface, string vif)
void	enable_interface_vif_cb (const XrlError &xrl_error, string interface, string vif)
void	disable_interface_vif_cb (const XrlError &xrl_error, string interface, string vif)
void	join_multicast_group_cb (const XrlError &xrl_error, string interface, string vif)
void	leave_multicast_group_cb (const XrlError &xrl_error, string interface, string vif)
Private Attributes
EventLoop &	_eventloop
XrlRouter &	_xrl_router
string	_feaname
string	_ribname
uint32_t	_component_count
IfMgrXrlMirror	_ifmgr
	libfeaclient wrapper.
IfMgrIfTree	_iftree
	local copy of interface state obtained from libfeaclient.
XrlQueue	_rib_queue
	Queue of RIB add/delete XRL commands.
XrlPortList	_ports
	List of active XrlPorts.
XrlDeadPortMap	_dead_ports
	XrlPorts awaiting I/O shutdown.
XrlQueue< A >	_rib_queue

---

Detailed Description

template<typename A>
class XrlIO< A >

Concrete implementation of IO using XRLs.

---

Constructor & Destructor Documentation

template<typename A>

XrlIO< A >::XrlIO	(	EventLoop &	eventloop,
		XrlRouter &	xrl_router,
		const string &	feaname,
		const string &	ribname
	)

Construct an XrlIO instance.

Parameters:

eventloop	the event loop for the OLSR process.
xrl_router	the name of the XRL router instance.
feaname	the name of the FEA XRL target.
ribname	the name of the RIB XRL target.

---

Member Function Documentation

template<typename A>

bool XrlIO< A >::add_route	(	IPv4Net	net,
		IPv4	nexthop,
		uint32_t	nexthop_id,
		uint32_t	metric,
		const PolicyTags &	policytags
	)		[virtual]

Add route to RIB.

Parameters:

net	network
nexthop
nexthop_id	interface ID towards the nexthop
metric	to network
policytags	policy info to the RIB.

Returns:

true if the route add was queued successfully, otherwise false.

Implements IO< A >.

template<typename A>

bool XrlIO< A >::add_route	(	IPNet< A >	net,
		A	nexthop,
		uint32_t	nexthop_id,
		uint32_t	metric,
		bool	equal,
		bool	discard,
		const PolicyTags &	policytags
	)		[virtual]

Add route to RIB.

Parameters:

net	network
nexthop
nexthop_id	interface ID towards the nexthop
metric	to network
equal	true if this in another route to the same destination.
discard	true if this is a discard route.
policytags	policy info to the RIB.

Implements IO< A >.

template<typename A>

void XrlIO< A >::component_down

(

string

name

)

Called when internal subsystem goes down.

Parameters:

name	the name of the affected subsystem

template<typename A>

void XrlIO< A >::component_up

(

string

name

)

Called when internal subsystem comes up.

Parameters:

name	the name of the affected subsystem

template<typename A>

bool XrlIO< A >::delete_route

(

IPv4Net

net

)

[virtual]

Delete route from RIB.

Parameters:

net	the destination to delete route for.

Returns:

true if the route delete was queued successfully, otherwise false.

Implements IO< A >.

template<typename A>

bool XrlIO< A >::disable_address	(	const string &	interface,
		const string &	vif,
		const IPv4 &	address,
		const uint16_t &	port
	)		[virtual]

Disable an IPv4 address and port for OLSR datagram reception.

Parameters:

interface	the interface to disable.
vif	the vif to disable.
address	the address to disable.
port	the port to disable.

Returns:

true if the address was disabled, otherwise false.

Implements IO< A >.

template<typename A>

bool XrlIO< A >::disable_interface_vif	(	const string &	interface,
		const string &	vif
	)		[virtual]

Disable this interface/vif from receiving frames.

XXX

Parameters:

interface	the name of the interface to disable.
vif	the name of the vif to disable.

Returns:

true if the interface/vif was disabled successfully, otherwise false.

Implements IO< A >.

template<typename A>

bool XrlIO< A >::enable_address	(	const string &	interface,
		const string &	vif,
		const IPv4 &	address,
		const uint16_t &	port,
		const IPv4 &	all_nodes_address
	)		[virtual]

Enable an IPv4 address and port for OLSR datagram reception and transmission.

Parameters:

interface	the interface to enable.
vif	the vif to enable.
address	the address to enable.
port	the port to enable.
all_nodes_address	the address to transmit to.

Returns:

true if the address was enabled, otherwise false.

Implements IO< A >.

template<typename A>

bool XrlIO< A >::enable_interface_vif	(	const string &	interface,
		const string &	vif
	)		[virtual]

Enable the interface/vif to receive frames.

XXX

Parameters:

interface	the name of the interface to enable.
vif	the name of the vif to enable.

Returns:

true if the interface/vif was enabled successfully, otherwise false.

Implements IO< A >.

template<typename A>

XrlPort * XrlIO< A >::find_port	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr
	)		[private]

Find OLSR port associated with interface, vif, address tuple.

Returns:

pointer to port on success, 0 if port could not be found.

template<typename A>

const XrlPort * XrlIO< A >::find_port	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr
	)		const [private]

Find OLSR port associated with interface, vif, address tuple.

Returns:

pointer to port on success, 0 if port could not be found.

template<typename A>

bool XrlIO< A >::get_addresses	(	const string &	interface,
		const string &	vif,
		list< A > &	addresses
	)		const [virtual]

Get all addresses associated with this interface/vif.

Parameters:

interface	the name of the interface
vif	the name of the vif
addresses	(out argument) list of associated addresses

Returns:

true if there are no errors.

Implements IO< A >.

template<typename A>

bool XrlIO< A >::get_addresses	(	const string &	interface,
		const string &	vif,
		list< IPv4 > &	addresses
	)		const [virtual]

Get all addresses associated with this interface/vif.

Parameters:

interface	the name of the interface
vif	the name of the vif
addresses	(out argument) list of associated addresses

Returns:

true if there are no errors.

Implements IO< A >.

template<typename A>

bool XrlIO< A >::get_broadcast_address	(	const string &	interface,
		const string &	vif,
		IPv4 &	address
	)		const

Get the broadcast address associated with this vif.

Parameters:

interface	the name of the interface
vif	the name of the vif
address	(out argument) "all nodes" address

Returns:

true if there are no errors.

template<typename A>

bool XrlIO< A >::get_broadcast_address	(	const string &	interface,
		const string &	vif,
		const IPv4 &	address,
		IPv4 &	bcast_address
	)		const [virtual]

Get the broadcast address associated with this IPv4 address.

Parameters:

interface	the name of the interface
vif	the name of the vif
address	IPv4 binding address
bcast_address	(out argument) primary broadcast address

Returns:

true if there are no errors.

Implements IO< A >.

template<typename A >

bool XrlIO< A >::get_interface_id	(	const string &	interface,
		uint32_t &	interface_id
	)		[virtual]

Get the interface ID.

Parameters:

interface	the name of the interface.
interface_id	the value if found..

Returns:

true if the interface ID has been found..

Implements IO< A >.

template<typename A>

bool XrlIO< A >::get_interface_id	(	const string &	interface,
		uint32_t &	interface_id
	)		[virtual]

Get the interface ID.

Parameters:

interface	the name of the interface.
interface_id	the value if found..

Returns:

true if the interface ID has been found..

Implements IO< A >.

template<typename A>

bool XrlIO< A >::get_link_local_address	(	const string &	interface,
		const string &	vif,
		A &	address
	)		[virtual]

Get a link local address for this interface/vif if available.

Parameters:

interface	the name of the interface
vif	the name of the vif
address	(out argument) set if address is found.

Returns:

true if a link local address is available.

Implements IO< A >.

template<typename A >

uint32_t XrlIO< A >::get_mtu

(

const string &

interface

)

[virtual]

Obtain the MTU for an interface.

Parameters:

interface

the name of the interface.

Returns:

the mtu for the interface.

Implements IO< A >.

template<typename A>

uint32_t XrlIO< A >::get_mtu

(

const string &

interface

)

[virtual]

Obtain the MTU for an interface.

Parameters:

the	name of the interface.

Returns:

the mtu for the interface.

Implements IO< A >.

template<typename A>

uint32_t XrlIO< A >::get_prefix_length	(	const string &	interface,
		const string &	vif,
		IPv4	address
	)

Obtain the subnet prefix length for an interface/vif/address.

Parameters:

interface	the name of the interface.
vif	the name of the vif.
address	the address.

Returns:

the subnet prefix length for the address.

template<typename A>

uint32_t XrlIO< A >::get_prefix_length	(	const string &	interface,
		const string &	vif,
		A	address
	)		[virtual]

Obtain the subnet prefix length for an interface/vif/address.

Parameters:

interface	the name of the interface.
vif	the name of the vif.
address	the address.

Returns:

the subnet prefix length for the address.

Implements IO< A >.

template<typename A>

const IfMgrIfTree& XrlIO< A >::ifmgr_iftree

(

)

const [inline, private]

Obtain a reference to the interface manager's interface tree.

Returns:

a reference to the interface manager's interface tree.

template<typename A>

const IfMgrIfTree& XrlIO< A >::ifmgr_iftree

(

)

const [inline, private]

Returns:

a reference to the interface manager's interface tree.

template<typename A>

const ServiceBase* XrlIO< A >::ifmgr_mirror_service_base

(

)

const [inline, private]

Obtain a pointer to the interface manager service base.

Returns:

a pointer to the interface manager service base.

template<typename A>

const ServiceBase* XrlIO< A >::ifmgr_mirror_service_base

(

)

const [inline, private]

Returns:

a pointer to the interface manager service base.

template<typename A>

bool XrlIO< A >::is_address_enabled	(	const string &	interface,
		const string &	vif,
		const IPv4 &	address
	)		const [virtual]

Test whether an interface/vif/address is enabled.

Parameters:

interface	the name of the interface to test.
vif	the name of the vif to test.
address	the address to test.

Returns:

true if it exists and is enabled, otherwise false.

Implements IO< A >.

template<typename A>

bool XrlIO< A >::is_address_enabled	(	const string &	interface,
		const string &	vif,
		const A &	address
	)		const [virtual]

Test whether an interface/vif/address is enabled.

Parameters:

interface	the name of the interface to test.
vif	the name of the vif to test.
address	the address to test.

Returns:

true if it exists and is enabled, otherwise false.

Implements IO< A >.

template<typename A >

bool XrlIO< A >::is_interface_enabled

(

const string &

interface

)

const [virtual]

Test whether an interface is enabled.

Parameters:

interface

the name of the interface to test.

Returns:

true if it exists and is enabled, otherwise false.

Implements IO< A >.

template<typename A>

bool XrlIO< A >::is_interface_enabled

(

const string &

interface

)

const [virtual]

Test whether an interface is enabled.

Parameters:

interface

the name of the interface to test.

Returns:

true if it exists and is enabled, otherwise false.

Implements IO< A >.

template<typename A>

bool XrlIO< A >::is_vif_broadcast_capable	(	const string &	interface,
		const string &	vif
	)		[virtual]

Test whether this interface/vif is broadcast capable.

Parameters:

interface	the interface to test.
vif	the vif to test.

Returns:

true if it is broadcast capable, otherwise false.

Implements IO< A >.

template<typename A >

bool XrlIO< A >::is_vif_enabled	(	const string &	interface,
		const string &	vif
	)		const [virtual]

Test whether an interface/vif is enabled.

Parameters:

interface	the name of the interface to test.
vif	the name of the vif to test.

Returns:

true if it exists and is enabled, otherwise false.

Implements IO< A >.

template<typename A>

bool XrlIO< A >::is_vif_enabled	(	const string &	interface,
		const string &	vif
	)		const [virtual]

Test whether an interface/vif is enabled.

Parameters:

interface	the name of the interface to test.
vif	the name of the vif to test.

Returns:

true if it exists and is enabled, otherwise false.

Implements IO< A >.

template<typename A>

bool XrlIO< A >::is_vif_multicast_capable	(	const string &	interface,
		const string &	vif
	)		[virtual]

Test whether this interface/vif is multicast capable.

Parameters:

interface	the interface to test.
vif	the vif to test.

Returns:

true if it is multicast capable, otherwise false.

Implements IO< A >.

template<typename A>

XrlPortList& XrlIO< A >::ports

(

)

[inline, private]

Returns:

pointer to list of active XrlPorts.

template<typename A>

const XrlPortList& XrlIO< A >::ports

(

)

const [inline, private]

Returns:

pointer to list of active XrlPorts.

template<typename A>

void XrlIO< A >::receive	(	const string &	sockid,
		const string &	interface,
		const string &	vif,
		const IPv4 &	src,
		const uint16_t &	sport,
		const vector< uint8_t > &	payload
	)

Receive UDP datagrams.

Specific to XrlIO.

Parameters:

sockid	the id of the socket.
interface	the interface where received.
vif	the vif where received.
src	the source port of the UDP datagram.
sport	the source address of the UDP datagram.
payload	the datagram payload.

template<typename A>

bool XrlIO< A >::replace_route	(	IPv4Net	net,
		IPv4	nexthop,
		uint32_t	nexthop_id,
		uint32_t	metric,
		const PolicyTags &	policytags
	)		[virtual]

Replace route in RIB.

Parameters:

net	network
nexthop
nexthop_id	interface ID towards the nexthop
metric	to network
policytags	policy info to the RIB.

Returns:

true if the route replacement was queued successfully, otherwise false.

Implements IO< A >.

template<typename A>

bool XrlIO< A >::replace_route	(	IPNet< A >	net,
		A	nexthop,
		uint32_t	nexthop_id,
		uint32_t	metric,
		bool	equal,
		bool	discard,
		const PolicyTags &	policytags
	)		[virtual]

Replace route in RIB.

Parameters:

net	network
nexthop
nexthop_id	interface ID towards the nexthop
metric	to network
equal	true if this in another route to the same destination.
discard	true if this is a discard route.
policytags	policy info to the RIB.

Implements IO< A >.

template<typename A >

void XrlIO< A >::rib_command_done	(	const XrlError &	error,
		bool	up,
		const char *	comment
	)

Callback method to: signal that an XRL command which has been sent to the RIB has returned.

Parameters:

error	the XRL command return code.
up	indicates if the RIB component has been brought up or down.
comment	text description of operation being performed.

template<typename A>

bool XrlIO< A >::send	(	const string &	interface,
		const string &	vif,
		const IPv4 &	src,
		const uint16_t &	sport,
		const IPv4 &	dst,
		const uint16_t &	dport,
		uint8_t *	data,
		const uint32_t &	len
	)		[virtual]

Send a UDP datagram on a specific link.

Parameters:

interface	the interface to send from.
vif	the vif to send from.
src	the IPv4 address to send from.
sport	the UDP port to send from.
dst	the IPv4 address to send to.
dport	the UDP port to send to.
data	the datagram payload.
len	the length of the buffer
data

Returns:

true if the datagram was queued successfully, otherwise false.

Implements IO< A >.

template<typename A>

void XrlIO< A >::send_cb

(

const XrlError &

xrl_error

)

[private]

Callback method to: signal that the XRL command to send a UDP datagram has returned.

Parameters:

xrl_error

the XRL command return code.

template<typename A>

int XrlIO< A >::shutdown

(

)

[inline, virtual]

Shutdown operation.

Returns:

XORP_OK on success, otherwise XORP_ERROR.

Implements ServiceBase.

template<typename A>

int XrlIO< A >::shutdown

(

)

[virtual]

Shutdown operation.

Returns:

XORP_OK on success, otherwise XORP_ERROR.

Implements ServiceBase.

template<typename A>

int XrlIO< A >::startup

(

)

[virtual]

Startup operation.

Returns:

XORP_OK on success, otherwise XORP_ERROR.

Implements ServiceBase.

template<typename A>

int XrlIO< A >::startup

(

)

[inline, virtual]

Startup operation.

Returns:

XORP_OK on success, otherwise XORP_ERROR.

Implements ServiceBase.

template<typename A>

void XrlIO< A >::status_change	(	ServiceBase *	service,
		ServiceStatus	old_status,
		ServiceStatus	new_status
	)		[private, virtual]

A method invoked when the status of a service changes.

Parameters:

service	the service whose status has changed.
old_status	the old status.
new_status	the new status.

Implements ServiceChangeObserverBase.

template<typename A>

void XrlIO< A >::status_change	(	ServiceBase *	service,
		ServiceStatus	old_status,
		ServiceStatus	new_status
	)		[inline, private, virtual]

A method invoked when the status of a service changes.

Parameters:

service	the service whose status has changed.
old_status	the old status.
new_status	the new status.

Implements ServiceChangeObserverBase.

---

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

• /home/greearb/git/xorp.ct.github/xorp/contrib/olsr/xrl_io.hh
• /home/greearb/git/xorp.ct.github/xorp/ospf/xrl_io.hh
• /home/greearb/git/xorp.ct.github/xorp/contrib/olsr/xrl_io.cc
• /home/greearb/git/xorp.ct.github/xorp/ospf/xrl_io.cc