XrlBgpTarget Class Reference

Inheritance diagram for XrlBgpTarget:

List of all members.

Public Member Functions
	XrlBgpTarget (XrlRouter *r, BGPMain &bgp)
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)
	Get status from Xrl Target.
XrlCmdError	common_0_1_shutdown ()
	Request target shut down cleanly.
XrlCmdError	common_0_1_startup ()
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_get_bgp_version (uint32_t &version)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_local_config (const string &as_num, const IPv4 &id, const bool &use_4byte_asnums)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_set_local_as (const string &as)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_get_local_as (string &as)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_set_4byte_as_support (const bool &enabled)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_set_bgp_id (const IPv4 &id)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_get_bgp_id (IPv4 &id)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_set_confederation_identifier (const string &as, const bool &disable)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_set_cluster_id (const IPv4 &cluster_id, const bool &disable)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_set_damping (const uint32_t &half_life, const uint32_t &max_suppress, const uint32_t &reuse, const uint32_t &suppress, const bool &disable)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_add_peer (const string &local_dev, const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, const string &as, const IPv4 &next_hop, const uint32_t &holdtime)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_delete_peer (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_enable_peer (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_disable_peer (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_change_local_ip (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, const string &new_local_ip, const string &new_local_dev)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_change_local_port (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, const uint32_t &new_local_port)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_change_peer_port (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, const uint32_t &new_peer_port)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_set_peer_as (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, const string &peer_as)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_set_holdtime (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, const uint32_t &holdtime)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_set_delay_open_time (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, const uint32_t &delay_open_time)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_set_route_reflector_client (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, const bool &state)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_set_confederation_member (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, const bool &state)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_set_prefix_limit (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, const uint32_t &maximum, const bool &state)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_set_nexthop4 (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, const IPv4 &next_hop)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_set_peer_state (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, const bool &state)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_set_peer_md5_password (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, const string &password)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_activate (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_next_hop_rewrite_filter (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, const IPv4 &next_hop)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_originate_route4 (const IPv4Net &nlri, const IPv4 &next_hop, const bool &unicast, const bool &multicast)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_withdraw_route4 (const IPv4Net &nlri, const bool &unicast, const bool &multicast)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_trace (const string &tvar, const bool &enable)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_get_peer_list_start (uint32_t &token, bool &more)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_get_peer_list_next (const uint32_t &token, string &local_ip, uint32_t &local_port, string &peer_ip, uint32_t &peer_port, bool &more)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_get_peer_id (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, IPv4 &peer_id)
XrlCmdError	bgp_0_3_get_peer_status (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, uint32_t &peer_state, uint32_t &admin_status)
XrlCmdError	bgp_0_3_get_peer_negotiated_version (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, int32_t &neg_version)
XrlCmdError	bgp_0_3_get_peer_as (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, string &peer_as)
XrlCmdError	bgp_0_3_get_peer_msg_stats (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, uint32_t &in_updates, uint32_t &out_updates, uint32_t &in_msgs, uint32_t &out_msgs, uint32_t &last_error, uint32_t &in_update_elapsed)
XrlCmdError	bgp_0_3_get_peer_established_stats (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, uint32_t &transitions, uint32_t &established_time)
XrlCmdError	bgp_0_3_get_peer_timer_config (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, uint32_t &retry_interval, uint32_t &hold_time, uint32_t &keep_alive, uint32_t &hold_time_conf, uint32_t &keep_alive_conf, uint32_t &min_as_origin_interval, uint32_t &min_route_adv_interval)
XrlCmdError	bgp_0_3_register_rib (const string &name)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_get_v4_route_list_start (const IPv4Net &net, const bool &unicast, const bool &multicast, uint32_t &token)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_get_v4_route_list_next (const uint32_t &token, IPv4 &peer_id, IPv4Net &net, uint32_t &best_and_origin, vector< uint8_t > &aspath, IPv4 &nexthop, int32_t &med, int32_t &localpref, int32_t &atomic_agg, vector< uint8_t > &aggregator, int32_t &calc_localpref, vector< uint8_t > &attr_unknown, bool &valid, bool &unicast, bool &multicast)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rib_client_0_1_route_info_changed4 (const IPv4 &addr, const uint32_t &prefix_len, const IPv4 &nexthop, const uint32_t &metric, const uint32_t &admin_distance, const string &protocol_origin)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	rib_client_0_1_route_info_invalid4 (const IPv4 &addr, const uint32_t &prefix_len)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	bgp_0_3_set_parameter (const string &local_ip, const uint32_t &local_port, const string &peer_ip, const uint32_t &peer_port, const string &parameter, const bool &toggle)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	finder_event_observer_0_1_xrl_target_birth (const string &target_class, const string &target_instance)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	finder_event_observer_0_1_xrl_target_death (const string &target_class, const string &target_instance)
	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:
XrlCmdError	profile_0_1_enable (const string &pname)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	profile_0_1_disable (const string &pname)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	profile_0_1_get_entries (const string &pname, const string &instance_name)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	profile_0_1_clear (const string &pname)
	Pure-virtual function that needs to be implemented to:
XrlCmdError	profile_0_1_list (string &info)
	Pure-virtual function that needs to be implemented to:
bool	waiting ()
bool	done ()
Private Attributes
BGPMain &	_bgp
	The main object that all requests go to.
bool	_awaiting_config
	Waiting for configuration.
bool	_awaiting_as
	Waiting for AS number.
AsNum	_as
	Local AS number.
bool	_awaiting_bgp_id
	Waiting for BGP id.
IPv4	_id
	BGP id.
bool	_awaiting_4byte_asnums
	Waiting for info on using 4-byte AS numbers.
bool	_use_4byte_asnums
	Do we use 4byte AS numbers?
bool	_done
	Set to true if we should be exiting.

---

Member Function Documentation

XrlCmdError XrlBgpTarget::bgp_0_3_activate	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Enable or disable the peering based on the peer state.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_add_peer	(	const string &	local_dev,
		const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port,
		const string &	as,
		const IPv4 &	next_hop,
		const uint32_t &	holdtime
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Add peer.

Parameters:

as	the peer's AS number.
next_hop	the local next hop.
holdtime	if traffic is not received in holdtime seconds a peering is considered down.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_change_local_ip	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port,
		const string &	new_local_ip,
		const string &	new_local_dev
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Change the local IP address and interface.

Parameters:

local_ip	current IP address.
local_port	server port.
peer_ip	IP address.
peer_port	peer port.
new_local_ip	new IP address.
new_local_dev	new Interface Name.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_change_local_port	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port,
		const uint32_t &	new_local_port
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Change the local port.

Parameters:

local_ip	current IP address.
local_port	server port.
peer_ip	IP address.
peer_port	peer port.
new_local_port	new local port.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_change_peer_port	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port,
		const uint32_t &	new_peer_port
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Change the peer port.

Parameters:

local_ip	current IP address.
local_port	server port.
peer_ip	IP address.
peer_port	peer port.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_delete_peer	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Delete peer.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_disable_peer	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Disable this peer.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_enable_peer	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Enable this peer.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_get_bgp_id

(

IPv4 &

id

)

[virtual]

Pure-virtual function that needs to be implemented to:

Get the BGP id.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_get_bgp_version

(

uint32_t &

version

)

[virtual]

Pure-virtual function that needs to be implemented to:

Get the BGP version currently running.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_get_local_as

(

string &

as

)

[virtual]

Pure-virtual function that needs to be implemented to:

Get the local AS number.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_get_peer_list_next	(	const uint32_t &	token,
		string &	local_ip,
		uint32_t &	local_port,
		string &	peer_ip,
		uint32_t &	peer_port,
		bool &	more
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get the next item of a list of BGP peers

Parameters:

token	token from prior call to get_peer_list
more	returned to indicate whether there are more list items remaining.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_get_peer_list_start	(	uint32_t &	token,
		bool &	more
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get the first item of a list of BGP peers See RFC 1657 (BGP MIB) for full definitions of return values.

Parameters:

token	returned token to be provided when calling get_peer_list_next.
more	returned to indicate whether there are more list items remaining.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_get_v4_route_list_next	(	const uint32_t &	token,
		IPv4 &	peer_id,
		IPv4Net &	net,
		uint32_t &	best_and_origin,
		vector< uint8_t > &	aspath,
		IPv4 &	nexthop,
		int32_t &	med,
		int32_t &	localpref,
		int32_t &	atomic_agg,
		vector< uint8_t > &	aggregator,
		int32_t &	calc_localpref,
		vector< uint8_t > &	attr_unknown,
		bool &	valid,
		bool &	unicast,
		bool &	multicast
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get the next route in the list See RFC 1657 (BGP MIB) for full definitions of return values.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_get_v4_route_list_start	(	const IPv4Net &	net,
		const bool &	unicast,
		const bool &	multicast,
		uint32_t &	token
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get the first item of a list of BGP routes See RFC 1657 (BGP MIB) for full definitions of return values.

Parameters:

net	the subtree to examine. NB Either unicast or multicast should be set to true, but not both.
unicast	request start of unicast routes.
multicast	request start of unicast routes.
token	returned token to be provided when calling get_route_list_next.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_local_config	(	const string &	as,
		const IPv4 &	id,
		const bool &	use_4byte_asnums
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get local config

Parameters:

id	our BGP ID.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_next_hop_rewrite_filter	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port,
		const IPv4 &	next_hop
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set next hop rewrite filter. XXX - This is a temporary hack until we get programmable filters.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_originate_route4	(	const IPv4Net &	nlri,
		const IPv4 &	next_hop,
		const bool &	unicast,
		const bool &	multicast
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Originate route IPv4

Parameters:

nlri	subnet to announce
next_hop	to forward to
unicast	if true install in unicast routing table
multicast	if true install in multicast routing table

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_register_rib

(

const string &

name

)

[virtual]

Pure-virtual function that needs to be implemented to:

Register rib.

Parameters:

name

rib name.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_set_4byte_as_support

(

const bool &

enable

)

[virtual]

Pure-virtual function that needs to be implemented to:

Allow 4-byte AS numbers.

Parameters:

enable

whether this is enabled.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_set_bgp_id

(

const IPv4 &

id

)

[virtual]

Pure-virtual function that needs to be implemented to:

Set the BGP id.

Parameters:

id	our BGP ID.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_set_cluster_id	(	const IPv4 &	cluster_id,
		const bool &	disable
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Route reflection.

Parameters:

cluster_id	the route reflection cluster ID.
disable	if true this router is a router reflector.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_set_confederation_identifier	(	const string &	as,
		const bool &	disable
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Confederation identifier.

Parameters:

as	externally visible AS number.
disable	true if confederations are disabled.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_set_confederation_member	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port,
		const bool &	state
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Is this peer a confederation member.

Parameters:

state

true if peer is a confederation member.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_set_damping	(	const uint32_t &	half_life,
		const uint32_t &	max_suppress,
		const uint32_t &	reuse,
		const uint32_t &	suppress,
		const bool &	disable
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Route Flap Damping. RFC 2439

Parameters:

half_life	decay half life in minutes.
max_suppress	maximum time in minutes a route can be held down.
reuse	threshold, point at which a route can be reused.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_set_delay_open_time	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port,
		const uint32_t &	delay_open_time
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set the delay open time

Parameters:

delay_open_time

to wait is seconds before sending an open.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_set_holdtime	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port,
		const uint32_t &	holdtime
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set the holdtime

Parameters:

holdtime

if traffic is not received in holdtime seconds a peering is considered down.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_set_local_as

(

const string &

as

)

[virtual]

Pure-virtual function that needs to be implemented to:

Set the local AS number.

Parameters:

as	our AS number.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_set_nexthop4	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port,
		const IPv4 &	next_hop
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set the peer's AS number.

Parameters:

next_hop

IPv4 nexthop.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_set_parameter	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port,
		const string &	parameter,
		const bool &	toggle
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set which parameters we support per peer

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_set_peer_as	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port,
		const string &	peer_as
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set the peer's AS number.

Parameters:

peer_as

the peer's AS number.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_set_peer_md5_password	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port,
		const string &	password
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set the peer md5 password.

Parameters:

password

the password to use for TCP-MD5 authentication.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_set_peer_state	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port,
		const bool &	toggle
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set the peer state enabled or disabled.

Parameters:

toggle

enabled or disabled.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_set_prefix_limit	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port,
		const uint32_t &	maximum,
		const bool &	state
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set the prefix limit.

Parameters:

maximum	number of prefixes
state	true if the prefix limit is being enforced

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_set_route_reflector_client	(	const string &	local_ip,
		const uint32_t &	local_port,
		const string &	peer_ip,
		const uint32_t &	peer_port,
		const bool &	state
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Set the route reflection client state. Is this peer a route reflector client.

Parameters:

state

true if peer is a route reflector client.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_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 XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::bgp_0_3_withdraw_route4	(	const IPv4Net &	nlri,
		const bool &	unicast,
		const bool &	multicast
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Withdraw route IPv4

Parameters:

nlri	subnet to withdraw
unicast	if true withdraw from unicast routing table
multicast	if true withdraw from multicast routing table

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::common_0_1_get_target_name

(

string &

name

)

[virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::common_0_1_get_version

(

string &

version

)

[virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::common_0_1_startup

(

)

[inline, virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::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 XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::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 XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::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 XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::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 XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::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 XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::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 XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::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 XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::profile_0_1_clear

(

const string &

pname

)

[virtual]

Pure-virtual function that needs to be implemented to:

Clear the profiling entries

Parameters:

pname

profile variable

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::profile_0_1_disable

(

const string &

pname

)

[virtual]

Pure-virtual function that needs to be implemented to:

Disable profiling

Parameters:

pname

profile variable

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::profile_0_1_enable

(

const string &

pname

)

[virtual]

Pure-virtual function that needs to be implemented to:

Enable profiling

Parameters:

pname

profile variable

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::profile_0_1_get_entries	(	const string &	pname,
		const string &	instance_name
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Get log entries.

Parameters:

pname	profile variable
instance_name	to send the profiling info to.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::profile_0_1_list

(

string &

info

)

[virtual]

Pure-virtual function that needs to be implemented to:

List all the profiling variables registered with this target.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::rib_client_0_1_route_info_changed4	(	const IPv4 &	addr,
		const uint32_t &	prefix_len,
		const IPv4 &	nexthop,
		const uint32_t &	metric,
		const uint32_t &	admin_distance,
		const string &	protocol_origin
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Route Info Changed route_info_changed is called by the RIB on the RIB client (typically a routing protocol) that had registered an interest in the routing of an address. This can be because the metric and/or nexthop changed.

Parameters:

addr	base address of the subnet that was registered
prefix_len	prefix length of the subnet that was registered
metric	the routing metric toward the address.
admin_distance	the administratively defined distance toward the address.
protocol_origin	the name of the protocol that originated this routing entry.

Implements XrlBgpTargetBase.

XrlCmdError XrlBgpTarget::rib_client_0_1_route_info_invalid4	(	const IPv4 &	addr,
		const uint32_t &	prefix_len
	)		[virtual]

Pure-virtual function that needs to be implemented to:

Route Info Invalid route_info_invalid is called by the RIB on the RIB client (typically a routing protocol) that had registere d an interest in the routing of an address. This can be because the information previously reported as applying no longer applies for any number of reasons. When the RIB sends this message, it has automatically de-registered interest in the route, and the client will normally need to send a register_interest request again.

Implements XrlBgpTargetBase.

---

Member Data Documentation

bool XrlBgpTarget::_awaiting_config [private]

Waiting for configuration.

Such as our own AS number.

---

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

• /home/greearb/git/xorp.ct.github/xorp/bgp/xrl_target.hh
• /home/greearb/git/xorp.ct.github/xorp/bgp/xrl_target.cc