class XrlShowRoutesTargetBase


 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

Protected Methods

Protected Members


Detailed Description

XrlCmdMap* _cmds

_cmds

[protected]

 XrlShowRoutesTargetBase (XrlCmdMap* cmds = 0)

XrlShowRoutesTargetBase

Constructor.

Parameters:

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

~XrlShowRoutesTargetBase

[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  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  redist6_0_1_add_route ( const IPv6Net& dst, const IPv6& nexthop, const string& ifname, const string& vifname, const uint32_t& metric, const uint32_t& admin_distance, const string& cookie, const string& protocol_origin)

redist6_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  redist6_0_1_delete_route ( const IPv6Net& dst, const IPv6& nexthop, const string& ifname, const string& vifname, const uint32_t& metric, const uint32_t& admin_distance, const string& cookie, const string& protocol_origin)

redist6_0_1_delete_route

[protected pure virtual]

XrlCmdError  redist6_0_1_starting_route_dump ( const string& cookie)

redist6_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  redist6_0_1_finishing_route_dump ( const string& cookie)

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

Generated by: pavlin on possum.icir.org on Wed Aug 2 15:36:11 2006, using kdoc $.