class XrlRipTargetBase


 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

Protected Methods

Protected Members


Detailed Description

XrlCmdMap* _cmds

_cmds

[protected]

 XrlRipTargetBase (XrlCmdMap* cmds = 0)

XrlRipTargetBase

Constructor.

Parameters:

cmdsan XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.
 ~XrlRipTargetBase ()

~XrlRipTargetBase

[virtual]

Destructor.

Dissociates instance commands from command map.

bool  set_command_map (XrlCmdMap* cmds)

set_command_map

Set command map.

Parameters:

cmdspointer 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.

inline const string&  name ()

name

[const]

Get Xrl instance name associated with command map.

inline const char*  version ()

version

[const]

Get version string of instance.

XrlCmdError  common_0_1_get_target_name ( string& name)

common_0_1_get_target_name

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

XrlCmdError  common_0_1_get_version ( string& version)

common_0_1_get_version

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

XrlCmdError  common_0_1_get_status ( uint32_t& status, string& reason)

common_0_1_get_status

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

XrlCmdError  common_0_1_shutdown ()

common_0_1_shutdown

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

XrlCmdError  finder_event_observer_0_1_xrl_target_birth ( const string& target_class, const string& target_instance)

finder_event_observer_0_1_xrl_target_birth

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target birth to observer.

Parameters:

target_classthe target class name.
target_instancethe target instance name.
XrlCmdError  finder_event_observer_0_1_xrl_target_death ( const string& target_class, const string& target_instance)

finder_event_observer_0_1_xrl_target_death

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target death to observer.

Parameters:

target_classthe target class name.
target_instancethe target instance name.
XrlCmdError  policy_backend_0_1_configure ( const uint32_t& filter, const string& conf)

policy_backend_0_1_configure

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Configure a policy filter.

Parameters:

filterthe identifier of the filter to configure.
confthe configuration of the filter.
XrlCmdError  policy_backend_0_1_reset ( const uint32_t& filter)

policy_backend_0_1_reset

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Reset a policy filter.

Parameters:

filterthe identifier of the filter to reset.
XrlCmdError  policy_backend_0_1_push_routes ()

policy_backend_0_1_push_routes

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

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)

policy_redist4_0_1_add_route4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Start route redistribution for an IPv4 route.

Parameters:

networkthe route to advertise.
unicastwhether the route is unicast.
multicastwhether the route is multicast.
nexthopthe nexthop of the route.
metricthe metric of the route.
policytagsthe set of policy-tags associated with the route.
XrlCmdError  policy_redist4_0_1_delete_route4 ( const IPv4Net& network, const bool& unicast, const bool& multicast)

policy_redist4_0_1_delete_route4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Terminate route redistribution for an IPv4 route.

Parameters:

networkthe route for which advertisements should cease.
unicastwhether the route is unicast.
multicastwhether the route is multicast.
XrlCmdError  redist4_0_1_add_route ( const IPv4Net& dst, const IPv4& nexthop, const string& ifname, const string& vifname, const uint32_t& metric, const uint32_t& admin_distance, const string& cookie, const string& protocol_origin)

redist4_0_1_add_route

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Add/delete a routing entry.

Parameters:

dstdestination network.
nexthopnexthop router address.
ifnameinterface name associated with nexthop.
vifnamevirtual interface name with nexthop.
metricorigin routing protocol metric for route.
admin_distanceadministrative distance of origin routing protocol.
cookievalue set by the requestor to identify redistribution source. Typical value is the originating protocol name.
protocol_originthe name of the protocol that originated this routing entry.
XrlCmdError  redist4_0_1_delete_route ( const IPv4Net& dst, const IPv4& nexthop, const string& ifname, const string& vifname, const uint32_t& metric, const uint32_t& admin_distance, const string& cookie, const string& protocol_origin)

redist4_0_1_delete_route

[protected pure virtual]

XrlCmdError  redist4_0_1_starting_route_dump ( const string& cookie)

redist4_0_1_starting_route_dump

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

When route redistribution begins, the receiver is sent the existing list of routes. This message marks the beginning of the routes being sent.

Parameters:

cookievalue set by the requestor to identify redistribution source. Typical value is the originating protocol name.
XrlCmdError  redist4_0_1_finishing_route_dump ( const string& cookie)

redist4_0_1_finishing_route_dump

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

When route redistribution begins, the receiver is sent the existing list of routes. This message marks the end of the existing routes being sent.

Parameters:

cookievalue set by the requestor to identify redistribution source. Typical value is the originating protocol name.
XrlCmdError  rip_0_1_add_rip_address ( const string& ifname, const string& vifname, const IPv4& addr)

rip_0_1_add_rip_address

[protected pure 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:

ifnamethe interface that owns vif that has address.
vifnamevirtual interface owning address.
addrthe address to be added.
XrlCmdError  rip_0_1_remove_rip_address ( const string& ifname, const string& vifname, const IPv4& addr)

rip_0_1_remove_rip_address

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Remove an address RIP process is running on.

Parameters:

ifnamethe interface that owns vif that has address.
vifnamevirtual interface owning address.
addrthe address to be removed.
XrlCmdError  rip_0_1_set_rip_address_enabled ( const string& ifname, const string& vifname, const IPv4& addr, const bool& enabled)

rip_0_1_set_rip_address_enabled

[protected pure virtual]

XrlCmdError  rip_0_1_rip_address_enabled ( const string& ifname, const string& vifname, const IPv4& addr, bool& enabled)

rip_0_1_rip_address_enabled

[protected pure virtual]

XrlCmdError  rip_0_1_set_cost ( const string& ifname, const string& vifname, const IPv4& addr, const uint32_t& cost)

rip_0_1_set_cost

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Set cost metric associated with address.

XrlCmdError  rip_0_1_cost ( const string& ifname, const string& vifname, const IPv4& addr, uint32_t& cost)

rip_0_1_cost

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get cost metric associated with address.

XrlCmdError  rip_0_1_set_horizon ( const string& ifname, const string& vifname, const IPv4& addr, const string& horizon)

rip_0_1_set_horizon

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Set horizon type applied to routes advertised from address.

Parameters:

horizonname of horizon type. Permitted values: "none", "poison-reverse" "split-horizon-poison-reverse"
XrlCmdError  rip_0_1_horizon ( const string& ifname, const string& vifname, const IPv4& addr, string& horizon)

rip_0_1_horizon

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get horizon type applied to routes advertised from address.

XrlCmdError  rip_0_1_set_passive ( const string& ifname, const string& vifname, const IPv4& addr, const bool& passive)

rip_0_1_set_passive

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

XrlCmdError  rip_0_1_passive ( const string& ifname, const string& vifname, const IPv4& addr, bool& passive)

rip_0_1_passive

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

XrlCmdError  rip_0_1_set_accept_non_rip_requests ( const string& ifname, const string& vifname, const IPv4& addr, const bool& accept)

rip_0_1_set_accept_non_rip_requests

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Accept and respond to non-RIP requests.

XrlCmdError  rip_0_1_accept_non_rip_requests ( const string& ifname, const string& vifname, const IPv4& addr, bool& accept)

rip_0_1_accept_non_rip_requests

[protected pure 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.

XrlCmdError  rip_0_1_set_accept_default_route ( const string& ifname, const string& vifname, const IPv4& addr, const bool& accept)

rip_0_1_set_accept_default_route

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Accept default route from peers.

XrlCmdError  rip_0_1_accept_default_route ( const string& ifname, const string& vifname, const IPv4& addr, bool& accept)

rip_0_1_accept_default_route

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Accessor for whether default route is accepted from peers.

XrlCmdError  rip_0_1_set_advertise_default_route ( const string& ifname, const string& vifname, const IPv4& addr, const bool& advertise)

rip_0_1_set_advertise_default_route

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Advertise default route (if present).

XrlCmdError  rip_0_1_advertise_default_route ( const string& ifname, const string& vifname, const IPv4& addr, bool& advertise)

rip_0_1_advertise_default_route

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Accessor for whether default route is advertised.

XrlCmdError  rip_0_1_set_route_timeout ( const string& ifname, const string& vifname, const IPv4& addr, const uint32_t& t_secs)

rip_0_1_set_route_timeout

[protected pure 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.

XrlCmdError  rip_0_1_route_timeout ( const string& ifname, const string& vifname, const IPv4& addr, uint32_t& t_secs)

rip_0_1_route_timeout

[protected pure 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.

XrlCmdError  rip_0_1_set_deletion_delay ( const string& ifname, const string& vifname, const IPv4& addr, const uint32_t& t_secs)

rip_0_1_set_deletion_delay

[protected pure 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.

XrlCmdError  rip_0_1_deletion_delay ( const string& ifname, const string& vifname, const IPv4& addr, uint32_t& t_secs)

rip_0_1_deletion_delay

[protected pure 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.

XrlCmdError  rip_0_1_set_request_interval ( const string& ifname, const string& vifname, const IPv4& addr, const uint32_t& t_secs)

rip_0_1_set_request_interval

[protected pure 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.

XrlCmdError  rip_0_1_request_interval ( const string& ifname, const string& vifname, const IPv4& addr, uint32_t& t_secs)

rip_0_1_request_interval

[protected pure 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.

XrlCmdError  rip_0_1_set_update_interval ( const string& ifname, const string& vifname, const IPv4& addr, const uint32_t& t_secs)

rip_0_1_set_update_interval

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

XrlCmdError  rip_0_1_update_interval ( const string& ifname, const string& vifname, const IPv4& addr, uint32_t& t_secs)

rip_0_1_update_interval

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

XrlCmdError  rip_0_1_set_update_jitter ( const string& ifname, const string& vifname, const IPv4& addr, const uint32_t& t_jitter)

rip_0_1_set_update_jitter

[protected pure 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).

XrlCmdError  rip_0_1_update_jitter ( const string& ifname, const string& vifname, const IPv4& addr, uint32_t& t_jitter)

rip_0_1_update_jitter

[protected pure 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).

XrlCmdError  rip_0_1_set_triggered_update_delay ( const string& ifname, const string& vifname, const IPv4& addr, const uint32_t& t_secs)

rip_0_1_set_triggered_update_delay

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Set period between sending triggered updates from address.

XrlCmdError  rip_0_1_triggered_update_delay ( const string& ifname, const string& vifname, const IPv4& addr, uint32_t& t_secs)

rip_0_1_triggered_update_delay

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get period between sending triggered updates from address.

XrlCmdError  rip_0_1_set_triggered_update_jitter ( const string& ifname, const string& vifname, const IPv4& addr, const uint32_t& t_jitter)

rip_0_1_set_triggered_update_jitter

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

XrlCmdError  rip_0_1_triggered_update_jitter ( const string& ifname, const string& vifname, const IPv4& addr, uint32_t& t_jitter)

rip_0_1_triggered_update_jitter

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

XrlCmdError  rip_0_1_set_interpacket_delay ( const string& ifname, const string& vifname, const IPv4& addr, const uint32_t& t_msecs)

rip_0_1_set_interpacket_delay

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

XrlCmdError  rip_0_1_interpacket_delay ( const string& ifname, const string& vifname, const IPv4& addr, uint32_t& t_msecs)

rip_0_1_interpacket_delay

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

XrlCmdError  rip_0_1_set_simple_authentication_key ( const string& ifname, const string& vifname, const IPv4& addr, const string& password)

rip_0_1_set_simple_authentication_key

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Set simple password authentication key.

Parameters:

ifnamethe interface name.
vifnamethe vif name.
addrthe address.
passwordthe authentication password.
XrlCmdError  rip_0_1_delete_simple_authentication_key ( const string& ifname, const string& vifname, const IPv4& addr)

rip_0_1_delete_simple_authentication_key

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Delete simple password authentication key.

Parameters:

ifnamethe interface name.
vifnamethe vif name.
addrthe address.
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)

rip_0_1_set_md5_authentication_key

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Set MD5 authentication key.

Parameters:

ifnamethe interface name.
vifnamethe vif name.
addrthe address.
key_idthe key ID (must be an integer in the interval [0, 255]).
passwordthe authentication password.
start_timethe authentication start time (YYYY-MM-DD.HH:MM).
end_timethe authentication end time (YYYY-MM-DD.HH:MM).
XrlCmdError  rip_0_1_delete_md5_authentication_key ( const string& ifname, const string& vifname, const IPv4& addr, const uint32_t& key_id)

rip_0_1_delete_md5_authentication_key

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Delete MD5 authentication key.

Parameters:

ifnamethe interface name.
vifnamethe vif name.
addrthe address.
key_idthe key ID (must be an integer in the interval [0, 255]).
XrlCmdError  rip_0_1_rip_address_status ( const string& ifname, const string& vifname, const IPv4& addr, string& status)

rip_0_1_rip_address_status

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

Parameters:

ifnamethe interface that owns vif that has the address.
vifnamevirtual interface owns the address.
addrthe address to query.
XrlCmdError  rip_0_1_get_all_addresses ( XrlAtomList& ifnames, XrlAtomList& vifnames, XrlAtomList& addrs)

rip_0_1_get_all_addresses

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get addresses running RIP.

XrlCmdError  rip_0_1_get_counters ( const string& ifname, const string& vifname, const IPv4& addr, XrlAtomList& counter_descriptions, XrlAtomList& counter_values)

rip_0_1_get_counters

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get counters associated with interface / vif /address.

XrlCmdError  rip_0_1_get_peers ( const string& ifname, const string& vifname, const IPv4& addr, XrlAtomList& peers)

rip_0_1_get_peers

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

XrlCmdError  rip_0_1_get_all_peers ( XrlAtomList& peers, XrlAtomList& ifnames, XrlAtomList& vifnames, XrlAtomList& addrs)

rip_0_1_get_all_peers

[protected pure 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.

XrlCmdError  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)

rip_0_1_get_peer_counters

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

Parameters:

counter_descriptionstextual descriptions of counters.
counter_valuesvalues associated with counters.
peer_last_activeis the number of seconds since TimeVal(0,0).
XrlCmdError  rip_0_1_redist_protocol_routes ( const string& protocol_name, const uint32_t& cost, const uint32_t& tag)

rip_0_1_redist_protocol_routes

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Configure protocol route redistribution.

Parameters:

protocol_namename of protocol to redistribute routes from.
costRIP cost metric to assign to protocol routes.
tagRIP tag to associate with protocol routes.
XrlCmdError  rip_0_1_no_redist_protocol_routes ( const string& protocol_name)

rip_0_1_no_redist_protocol_routes

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Remove protocol route redistribution.

Parameters:

protocol_namename of protocol to stop redistribution of routes from.
XrlCmdError  socket4_user_0_1_recv_event ( const string& sockid, const IPv4& src_host, const uint32_t& src_port, const vector<uint8_t>& data)

socket4_user_0_1_recv_event

[protected pure 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:

sockidthe identifier associated with socket where error occurred.
src_hostthe originating host.
src_portthe originating IP port.
datathe data received.
XrlCmdError  socket4_user_0_1_connect_event ( const string& sockid, const IPv4& src_host, const uint32_t& src_port, const string& new_sockid, bool& accept)

socket4_user_0_1_connect_event

[protected pure 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.

XrlCmdError  socket4_user_0_1_error_event ( const string& sockid, const string& error, const bool& fatal)

socket4_user_0_1_error_event

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

Parameters:

sockidthe identifier associated with socket where error occurred.
errora textual description of the error.
fatalindication of whether socket is shutdown because of error.
XrlCmdError  socket4_user_0_1_close_event ( const string& sockid, const string& reason)

socket4_user_0_1_close_event

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Method invoked by target implementing socket4/0.1 when a socket is forcibly closed. This would typically happen when the address the socket is bound to is removed from an interface. This method is not called if the socket is closed through socket/0.1/close.


Generated by: pavlin on possum.icir.org on Wed Mar 21 11:23:08 2007, using kdoc $.