XrlRipTarget Class Reference

Inheritance diagram for XrlRipTarget:

List of all members.

Public Member Functions
	XrlRipTarget (EventLoop &e, XrlRouter &xr, XrlProcessSpy &xps, XrlPortManager< IPv4 > &xpm, XrlRedistManager< IPv4 > &xrm, System< IPv4 > &rip_system)
void	set_status (ProcessStatus ps, const string &annotation="")
XrlCmdError	common_0_1_get_target_name (string &name)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	common_0_1_get_version (string &version)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	common_0_1_get_status (uint32_t &status, string &reason)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	common_0_1_shutdown ()
	Pure-virtual function that needs to be implemented to:
XrlCmdError	common_0_1_startup ()
	Pure-virtual function that needs to be implemented to:
XrlCmdError	finder_event_observer_0_1_xrl_target_birth (const string &class_name, const string &instance_name)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	finder_event_observer_0_1_xrl_target_death (const string &class_name, const string &instance_name)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_add_rip_address (const string &ifname, const string &vifname, const IPv4 &addr)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_remove_rip_address (const string &ifname, const string &vifname, const IPv4 &addr)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_set_rip_address_enabled (const string &ifname, const string &vifname, const IPv4 &addr, const bool &enabled)
XrlCmdError	rip_0_1_rip_address_enabled (const string &ifname, const string &vifname, const IPv4 &addr, bool &enabled)
XrlCmdError	rip_0_1_set_cost (const string &ifname, const string &vifname, const IPv4 &addr, const uint32_t &cost)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_cost (const string &ifname, const string &vifname, const IPv4 &addr, uint32_t &cost)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_set_horizon (const string &ifname, const string &vifname, const IPv4 &addr, const string &horizon)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_horizon (const string &ifname, const string &vifname, const IPv4 &addr, string &horizon)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_set_passive (const string &ifname, const string &vifname, const IPv4 &addr, const bool &passive)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_passive (const string &ifname, const string &vifname, const IPv4 &addr, bool &passive)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_set_accept_non_rip_requests (const string &ifname, const string &vifname, const IPv4 &addr, const bool &accept)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_accept_non_rip_requests (const string &ifname, const string &vifname, const IPv4 &addr, bool &accept)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_set_accept_default_route (const string &ifname, const string &vifname, const IPv4 &addr, const bool &accept)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_accept_default_route (const string &ifname, const string &vifname, const IPv4 &addr, bool &accept)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_set_advertise_default_route (const string &ifname, const string &vifname, const IPv4 &addr, const bool &advertise)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_advertise_default_route (const string &ifname, const string &vifname, const IPv4 &addr, bool &advertise)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_set_route_timeout (const string &ifname, const string &vifname, const IPv4 &addr, const uint32_t &t_secs)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_route_timeout (const string &ifname, const string &vifname, const IPv4 &addr, uint32_t &t_secs)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_set_deletion_delay (const string &ifname, const string &vifname, const IPv4 &addr, const uint32_t &t_secs)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_deletion_delay (const string &ifname, const string &vifname, const IPv4 &addr, uint32_t &t_secs)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_set_request_interval (const string &ifname, const string &vifname, const IPv4 &addr, const uint32_t &t_secs)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_request_interval (const string &ifname, const string &vifname, const IPv4 &addr, uint32_t &t_secs)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_set_update_interval (const string &ifname, const string &vifname, const IPv4 &addr, const uint32_t &t_secs)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_update_interval (const string &ifname, const string &vifname, const IPv4 &addr, uint32_t &t_secs)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_set_update_jitter (const string &ifname, const string &vifname, const IPv4 &addr, const uint32_t &t_jitter)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_update_jitter (const string &ifname, const string &vifname, const IPv4 &addr, uint32_t &t_jitter)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_set_triggered_update_delay (const string &ifname, const string &vifname, const IPv4 &addr, const uint32_t &t_secs)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_triggered_update_delay (const string &ifname, const string &vifname, const IPv4 &addr, uint32_t &t_secs)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_set_triggered_update_jitter (const string &ifname, const string &vifname, const IPv4 &addr, const uint32_t &t_jitter)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_triggered_update_jitter (const string &ifname, const string &vifname, const IPv4 &addr, uint32_t &t_jitter)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_set_interpacket_delay (const string &ifname, const string &vifname, const IPv4 &addr, const uint32_t &t_msecs)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_interpacket_delay (const string &ifname, const string &vifname, const IPv4 &addr, uint32_t &t_msecs)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_set_simple_authentication_key (const string &ifname, const string &vifname, const IPv4 &addr, const string &password)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_delete_simple_authentication_key (const string &ifname, const string &vifname, const IPv4 &addr)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_set_md5_authentication_key (const string &ifname, const string &vifname, const IPv4 &addr, const uint32_t &key_id, const string &password, const string &start_time, const string &end_time)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_delete_md5_authentication_key (const string &ifname, const string &vifname, const IPv4 &addr, const uint32_t &key_id)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_rip_address_status (const string &ifname, const string &vifname, const IPv4 &addr, string &status)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_get_all_addresses (XrlAtomList &ifnames, XrlAtomList &vifnames, XrlAtomList &addrs)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_get_peers (const string &ifname, const string &vifname, const IPv4 &addr, XrlAtomList &peers)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_get_all_peers (XrlAtomList &peers, XrlAtomList &ifnames, XrlAtomList &vifnames, XrlAtomList &addrs)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_get_counters (const string &ifname, const string &vifname, const IPv4 &addr, XrlAtomList &descriptions, XrlAtomList &values)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_get_peer_counters (const string &ifname, const string &vifname, const IPv4 &addr, const IPv4 &peer, XrlAtomList &descriptions, XrlAtomList &values, uint32_t &peer_last_active)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rip_0_1_trace (const string &tvar, const bool &enable)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	socket4_user_0_1_recv_event (const string &sockid, const string &if_name, const string &vif_name, const IPv4 &src_host, const uint32_t &src_port, const vector< uint8_t > &pdata)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	socket4_user_0_1_inbound_connect_event (const string &sockid, const IPv4 &src_host, const uint32_t &src_port, const string &new_sockid, bool &accept)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	socket4_user_0_1_outgoing_connect_event (const string &sockid)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	socket4_user_0_1_error_event (const string &sockid, const string &reason, const bool &fatal)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	socket4_user_0_1_disconnect_event (const string &sockid)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	policy_backend_0_1_configure (const uint32_t &filter, const string &conf)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	policy_backend_0_1_reset (const uint32_t &filter)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	policy_backend_0_1_push_routes ()
	Pure-virtual function that needs to be implemented to:
XrlCmdError	policy_redist4_0_1_add_route4 (const IPv4Net &network, const bool &unicast, const bool &multicast, const IPv4 &nexthop, const uint32_t &metric, const XrlAtomList &policytags)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	policy_redist4_0_1_delete_route4 (const IPv4Net &network, const bool &unicast, const bool &multicast)
	Pure-virtual function that needs to be implemented to:
Protected Attributes
EventLoop &	_e
XrlRipCommonTarget< IPv4 > *	_ct

---

Member Function Documentation

XrlCmdError XrlRipTarget::common_0_1_get_status	(	uint32_t &	status,
		string &	reason
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::common_0_1_get_target_name

(

string &

name

)

[virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::common_0_1_get_version

(

string &

version

)

[virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::common_0_1_shutdown

(

)

[virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::common_0_1_startup

(

)

[virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::finder_event_observer_0_1_xrl_target_birth	(	const string &	target_class,
		const string &	target_instance
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Announce target birth to observer.

Parameters:

target_class	the target class name.
target_instance	the target instance name.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::finder_event_observer_0_1_xrl_target_death	(	const string &	target_class,
		const string &	target_instance
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Announce target death to observer.

Parameters:

target_class	the target class name.
target_instance	the target instance name.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::policy_backend_0_1_configure	(	const uint32_t &	filter,
		const string &	conf
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Configure a policy filter.

Parameters:

filter	the identifier of the filter to configure.
conf	the configuration of the filter.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::policy_backend_0_1_push_routes

(

)

[virtual]

Pure-virtual function that needs to be implemented to:

Push all available routes through all filters for re-filtering.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::policy_backend_0_1_reset

(

const uint32_t &

filter

)

[virtual]

Pure-virtual function that needs to be implemented to:

Reset a policy filter.

Parameters:

filter

the identifier of the filter to reset.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::policy_redist4_0_1_add_route4	(	const IPv4Net &	network,
		const bool &	unicast,
		const bool &	multicast,
		const IPv4 &	nexthop,
		const uint32_t &	metric,
		const XrlAtomList &	policytags
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Start route redistribution for an IPv4 route.

Parameters:

network	the route to advertise.
unicast	whether the route is unicast.
multicast	whether the route is multicast.
nexthop	the nexthop of the route.
metric	the metric of the route.
policytags	the set of policy-tags associated with the route.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::policy_redist4_0_1_delete_route4	(	const IPv4Net &	network,
		const bool &	unicast,
		const bool &	multicast
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Terminate route redistribution for an IPv4 route.

Parameters:

network	the route for which advertisements should cease.
unicast	whether the route is unicast.
multicast	whether the route is multicast.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_accept_default_route	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		bool &	accept
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Accessor for whether default route is accepted from peers.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_accept_non_rip_requests	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		bool &	accept
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get value indicating whether non-RIP requests are accepted and responded to on interface/vif/address.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_add_rip_address	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Add an address to run RIP process on. The addition of address is not instantaneous, RIP has to instantiate state in the FEA to send and receive packets. Once instantiated the address must be explicitly enabled with set_rip_address_enabled.

Parameters:

ifname	the interface that owns vif that has address.
vifname	virtual interface owning address.
addr	the address to be added.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_advertise_default_route	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		bool &	advertise
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Accessor for whether default route is advertised.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_cost	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		uint32_t &	cost
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get cost metric associated with address.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_delete_md5_authentication_key	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const uint32_t &	key_id
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Delete MD5 authentication key.

Parameters:

ifname	the interface name.
vifname	the vif name.
addr	the address.
key_id	the key ID (must be an integer in the interval [0, 255]).

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_delete_simple_authentication_key	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Delete simple password authentication key.

Parameters:

ifname	the interface name.
vifname	the vif name.
addr	the address.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_deletion_delay	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		uint32_t &	t_secs
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get period that routes associated with reception address will be deleted after they've expired.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_get_all_addresses	(	XrlAtomList &	ifnames,
		XrlAtomList &	vifnames,
		XrlAtomList &	addrs
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get addresses running RIP.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_get_all_peers	(	XrlAtomList &	peers,
		XrlAtomList &	ifnames,
		XrlAtomList &	vifnames,
		XrlAtomList &	addrs
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get list of all peers known to RIP. There is a 1-to-1 correspondence between the items in the lists of peers, ifnames, vifnames, addrs.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_get_counters	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		XrlAtomList &	counter_descriptions,
		XrlAtomList &	counter_values
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get counters associated with interface / vif /address.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_get_peer_counters	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const IPv4 &	peer,
		XrlAtomList &	counter_descriptions,
		XrlAtomList &	counter_values,
		uint32_t &	peer_last_active
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get counters associated with peer of interface / vif /address.

Parameters:

counter_descriptions	textual descriptions of counters.
counter_values	values associated with counters.
peer_last_active	is the number of seconds since TimeVal(0,0).

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_get_peers	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		XrlAtomList &	peers
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get the list of peers associated with interface / vif / address.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_horizon	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		string &	horizon
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get horizon type applied to routes advertised from address.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_interpacket_delay	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		uint32_t &	t_msecs
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get the inter-packet delay between the output of packets from address.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_passive	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		bool &	passive
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get value indicating whether RIP is passive (receive only) on interface/vif/address.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_remove_rip_address	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Remove an address RIP process is running on.

Parameters:

ifname	the interface that owns vif that has address.
vifname	virtual interface owning address.
addr	the address to be removed.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_request_interval	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		uint32_t &	t_secs
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set period that route table requests should be sent from address when no peers are associated with it.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_rip_address_status	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		string &	status
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get a textual description of the status of address RIP is running upon.

Parameters:

ifname	the interface that owns vif that has the address.
vifname	virtual interface owns the address.
addr	the address to query.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_route_timeout	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		uint32_t &	t_secs
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get period that routes associated with reception address will expire in the absence of updates.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_set_accept_default_route	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const bool &	accept
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Accept default route from peers.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_set_accept_non_rip_requests	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const bool &	accept
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Accept and respond to non-RIP requests.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_set_advertise_default_route	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const bool &	advertise
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Advertise default route (if present).

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_set_cost	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const uint32_t &	cost
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set cost metric associated with address.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_set_deletion_delay	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const uint32_t &	t_secs
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set period that routes associated with reception address will be deleted after they've expired.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_set_horizon	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const string &	horizon
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set horizon type applied to routes advertised from address.

Parameters:

horizon

name of horizon type. Permitted values: "none", "poison-reverse" "split-horizon-poison-reverse"

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_set_interpacket_delay	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const uint32_t &	t_msecs
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set the inter-packet delay between the output of packets from address.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_set_md5_authentication_key	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const uint32_t &	key_id,
		const string &	password,
		const string &	start_time,
		const string &	end_time
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set MD5 authentication key.

Parameters:

ifname	the interface name.
vifname	the vif name.
addr	the address.
key_id	the key ID (must be an integer in the interval [0, 255]).
password	the authentication password.
start_time	the authentication start time (YYYY-MM-DD.HH:MM).
end_time	the authentication end time (YYYY-MM-DD.HH:MM).

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_set_passive	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const bool &	passive
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Make RIP passive (receive only) on interface/vif/address.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_set_request_interval	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const uint32_t &	t_secs
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set period that route table requests should be sent from address when no peers are associated with it.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_set_route_timeout	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const uint32_t &	t_secs
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set period that routes associated with reception address will expire in the absence of updates.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_set_simple_authentication_key	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const string &	password
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set simple password authentication key.

Parameters:

ifname	the interface name.
vifname	the vif name.
addr	the address.
password	the authentication password.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_set_triggered_update_delay	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const uint32_t &	t_secs
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set period between sending triggered updates from address.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_set_triggered_update_jitter	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const uint32_t &	t_jitter
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set jitter between sending triggered updates from address (in percents of the period).

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_set_update_interval	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const uint32_t &	t_secs
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set period between the unsolicited sending of the routing table from address.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_set_update_jitter	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		const uint32_t &	t_jitter
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set jitter between the unsolicited sending of the routing table from address (in percents of the period).

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_trace	(	const string &	tvar,
		const bool &	enable
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Enable/Disable tracing.

Parameters:

tvar	trace variable.
enable	set to true to enable false to disable.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_triggered_update_delay	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		uint32_t &	t_secs
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get period between sending triggered updates from address.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_triggered_update_jitter	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		uint32_t &	t_jitter
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get jitter between sending triggered updates from address (in percents of the period).

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_update_interval	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		uint32_t &	t_secs
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get period between the unsolicited sending of the routing table from address.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::rip_0_1_update_jitter	(	const string &	ifname,
		const string &	vifname,
		const IPv4 &	addr,
		uint32_t &	t_jitter
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get jitter between the unsolicited sending of the routing table from address (in percents of the period).

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::socket4_user_0_1_disconnect_event

(

const string &

sockid

)

[virtual]

Pure-virtual function that needs to be implemented to:

Method invoked by target implementing socket4/0.1 when the peer has closed the connection. It applies only to TCP sockets. Note that the socket itself is left open and must be explicitly closed.

Parameters:

sockid

the identifier associated with socket where the event occurred.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::socket4_user_0_1_error_event	(	const string &	sockid,
		const string &	error,
		const bool &	fatal
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Method invoked by target implementing socket4/0.1 when an error occurs.

Parameters:

sockid	the identifier associated with socket where the event occurred.
error	a textual description of the error.
fatal	indication of whether socket is shutdown because of error.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::socket4_user_0_1_inbound_connect_event	(	const string &	sockid,
		const IPv4 &	src_host,
		const uint32_t &	src_port,
		const string &	new_sockid,
		bool &	accept
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Method invoked by target implementing socket4/0.1 when a connection request is received from an IPv4 source. It applies only to TCP sockets.

Parameters:

sockid	the identifier associated with socket where the event occurred.
src_host	the connecting host.
src_port	the connecting IP port.
new_sockid	the identifier associated with the new socket that has been created to handle the new connection.
accept	if true, the connection request has been accepted, otherwise it has been rejected.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::socket4_user_0_1_outgoing_connect_event

(

const string &

sockid

)

[virtual]

Pure-virtual function that needs to be implemented to:

Method invoked by target implementing socket4/0.1 when an outgoing connection request originated by the local host is completed. It applies only to TCP sockets. Note that if the connection failed, the error_event will be dispatched instead.

Parameters:

sockid

the identifier associated with socket where the event occurred.

Implements XrlRipTargetBase.

XrlCmdError XrlRipTarget::socket4_user_0_1_recv_event	(	const string &	sockid,
		const string &	if_name,
		const string &	vif_name,
		const IPv4 &	src_host,
		const uint32_t &	src_port,
		const vector< uint8_t > &	data
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Method invoked by target implementing socket4/0.1 when a packet arrives from an IPv4 source.

Parameters:

sockid	the identifier associated with socket where the event occurred.
if_name	the interface name the packet arrived on, if known. If unknown, then it is an empty string.
vif_name	the vif name the packet arrived on, if known. If unknown, then it is an empty string.
src_host	the originating host.
src_port	the originating IP port.
data	the data received.

Implements XrlRipTargetBase.

---

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

• /home/greearb/git/xorp.ct.github/xorp/rip/xrl_target_rip.hh
• /home/greearb/git/xorp.ct.github/xorp/rip/xrl_target_rip.cc