class XrlFib2mribTargetBase


 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

Protected Methods

Protected Members


Detailed Description

XrlCmdMap* _cmds

_cmds

[protected]

 XrlFib2mribTargetBase (XrlCmdMap* cmds = 0)

XrlFib2mribTargetBase

Constructor.

Parameters:

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

~XrlFib2mribTargetBase

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

const string&  name ()

name

[const]

Get Xrl instance name associated with command map.

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  fea_fib_client_0_1_add_route4 ( const IPv4Net& network, const IPv4& nexthop, const string& ifname, const string& vifname, const uint32_t& metric, const uint32_t& admin_distance, const string& protocol_origin, const bool& xorp_route)

fea_fib_client_0_1_add_route4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Notification of a route being added.

Parameters:

networkthe network address prefix of the route to add.
nexthopthe address of the next-hop router toward the destination.
ifnamethe name of the physical interface toward the destination.
vifnamethe name of the virtual interface toward the destination.
metricthe routing metric toward the destination.
admin_distancethe administratively defined distance toward the destination.
protocol_originthe name of the protocol that originated this route.
xorp_routetrue if this route was installed by XORP.
XrlCmdError  fea_fib_client_0_1_add_route6 ( const IPv6Net& network, const IPv6& nexthop, const string& ifname, const string& vifname, const uint32_t& metric, const uint32_t& admin_distance, const string& protocol_origin, const bool& xorp_route)

fea_fib_client_0_1_add_route6

[protected pure virtual]

XrlCmdError  fea_fib_client_0_1_replace_route4 ( const IPv4Net& network, const IPv4& nexthop, const string& ifname, const string& vifname, const uint32_t& metric, const uint32_t& admin_distance, const string& protocol_origin, const bool& xorp_route)

fea_fib_client_0_1_replace_route4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Notification of a route being replaced.

Parameters:

networkthe network address prefix of the route to replace.
nexthopthe address of the next-hop router toward the destination.
ifnamethe name of the physical interface toward the destination.
vifnamethe name of the virtual interface toward the destination.
metricthe routing metric toward the destination.
admin_distancethe administratively defined distance toward the destination.
protocol_originthe name of the protocol that originated this route.
xorp_routetrue if this route was installed by XORP.
XrlCmdError  fea_fib_client_0_1_replace_route6 ( const IPv6Net& network, const IPv6& nexthop, const string& ifname, const string& vifname, const uint32_t& metric, const uint32_t& admin_distance, const string& protocol_origin, const bool& xorp_route)

fea_fib_client_0_1_replace_route6

[protected pure virtual]

XrlCmdError  fea_fib_client_0_1_delete_route4 ( const IPv4Net& network, const string& ifname, const string& vifname)

fea_fib_client_0_1_delete_route4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Notification of a route being deleted.

Parameters:

networkthe network address prefix of the route to delete.
ifnamethe name of the physical interface toward the destination.
vifnamethe name of the virtual interface toward the destination.
XrlCmdError  fea_fib_client_0_1_delete_route6 ( const IPv6Net& network, const string& ifname, const string& vifname)

fea_fib_client_0_1_delete_route6

[protected pure virtual]

XrlCmdError  fea_fib_client_0_1_resolve_route4 ( const IPv4Net& network)

fea_fib_client_0_1_resolve_route4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Notification of a route resolution request. This is issued when the forwarding plane cannot find any route to a given destination, even a candidate default.

Parameters:

networkthe address of the destination. forwarding plane requires a route to be resolved by the upper layer.
XrlCmdError  fea_fib_client_0_1_resolve_route6 ( const IPv6Net& network)

fea_fib_client_0_1_resolve_route6

[protected pure virtual]

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  fib2mrib_0_1_enable_fib2mrib ( const bool& enable)

fib2mrib_0_1_enable_fib2mrib

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Enable/disable/start/stop Fib2mrib.

Parameters:

enableif true, then enable Fib2mrib, otherwise disable it.
XrlCmdError  fib2mrib_0_1_start_fib2mrib ()

fib2mrib_0_1_start_fib2mrib

[protected pure virtual]

XrlCmdError  fib2mrib_0_1_stop_fib2mrib ()

fib2mrib_0_1_stop_fib2mrib

[protected pure virtual]

XrlCmdError  fib2mrib_0_1_enable_log_trace_all ( const bool& enable)

fib2mrib_0_1_enable_log_trace_all

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Enable/disable the Fib2mrib trace log for all operations.

Parameters:

enableif true, then enable the trace log, otherwise disable it.

Generated by: pavlin on kobe.xorp.net on Wed Jan 7 19:10:51 2009, using kdoc 2.0a54+XORP.