xorp

XrlShowRoutesTargetBase Class Reference

Inheritance diagram for XrlShowRoutesTargetBase:
ShowRoutesProcessor

List of all members.

Classes

struct  handler_table

Public Member Functions

 XrlShowRoutesTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlShowRoutesTargetBase ()
 Destructor.
bool set_command_map (XrlCmdMap *cmds)
 Set command map.
const string & get_name () const
 Get Xrl instance name associated with command map.
const char * version () const
 Get version string of instance.
 XrlShowRoutesTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlShowRoutesTargetBase ()
 Destructor.
bool set_command_map (XrlCmdMap *cmds)
 Set command map.
const string & get_name () const
 Get Xrl instance name associated with command map.
const char * version () const
 Get version string of instance.

Protected Member Functions

virtual XrlCmdError common_0_1_get_target_name (string &name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_version (string &version)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_status (uint32_t &status, string &reason)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_shutdown ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_startup ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_birth (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_death (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual 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)=0
 Pure-virtual function that needs to be implemented to:
virtual 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)=0
virtual XrlCmdError redist4_0_1_starting_route_dump (const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError redist4_0_1_finishing_route_dump (const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual 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)=0
 Pure-virtual function that needs to be implemented to:
virtual 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)=0
virtual XrlCmdError redist6_0_1_starting_route_dump (const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError redist6_0_1_finishing_route_dump (const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_target_name (string &name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_version (string &version)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_status (uint32_t &status, string &reason)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_shutdown ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_startup ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_birth (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_death (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual 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)=0
 Pure-virtual function that needs to be implemented to:
virtual 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)=0
virtual XrlCmdError redist4_0_1_starting_route_dump (const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError redist4_0_1_finishing_route_dump (const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual 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)=0
 Pure-virtual function that needs to be implemented to:
virtual 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)=0
virtual XrlCmdError redist6_0_1_starting_route_dump (const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError redist6_0_1_finishing_route_dump (const string &cookie)=0
 Pure-virtual function that needs to be implemented to:

Protected Attributes

XrlCmdMap_cmds

Private Member Functions

XrlCmdRT handle_common_0_1_get_target_name (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_version (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_status (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_shutdown (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_startup (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_birth (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_death (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_redist4_0_1_add_route (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_redist4_0_1_delete_route (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_redist4_0_1_starting_route_dump (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_redist4_0_1_finishing_route_dump (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_redist6_0_1_add_route (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_redist6_0_1_delete_route (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_redist6_0_1_starting_route_dump (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_redist6_0_1_finishing_route_dump (const XrlArgs &in, XrlCmdOT out)
void add_handlers ()
void remove_handlers ()
XrlCmdRT handle_common_0_1_get_target_name (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_version (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_status (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_shutdown (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_startup (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_birth (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_death (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_redist4_0_1_add_route (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_redist4_0_1_delete_route (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_redist4_0_1_starting_route_dump (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_redist4_0_1_finishing_route_dump (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_redist6_0_1_add_route (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_redist6_0_1_delete_route (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_redist6_0_1_starting_route_dump (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_redist6_0_1_finishing_route_dump (const XrlArgs &in, XrlCmdOT out)
void add_handlers ()
void remove_handlers ()

Static Private Attributes

static struct handler_table handlers []
static const size_t num_handlers = (sizeof(XrlShowRoutesTargetBase::handlers) / sizeof(XrlShowRoutesTargetBase::handlers[0]))

Constructor & Destructor Documentation

XrlShowRoutesTargetBase::XrlShowRoutesTargetBase ( XrlCmdMap cmds = 0)

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.

XrlShowRoutesTargetBase::XrlShowRoutesTargetBase ( XrlCmdMap cmds = 0)

Constructor.

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

Destructor.

Dissociates instance commands from command map.


Member Function Documentation

virtual XrlCmdError XrlShowRoutesTargetBase::common_0_1_get_status ( uint32_t &  status,
string &  reason 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::common_0_1_get_status ( uint32_t &  status,
string &  reason 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::common_0_1_get_target_name ( string &  name) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::common_0_1_get_target_name ( string &  name) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::common_0_1_get_version ( string &  version) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::common_0_1_get_version ( string &  version) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::common_0_1_shutdown ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::common_0_1_shutdown ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::common_0_1_startup ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::common_0_1_startup ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::finder_event_observer_0_1_xrl_target_birth ( const string &  target_class,
const string &  target_instance 
) [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.

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::finder_event_observer_0_1_xrl_target_birth ( const string &  target_class,
const string &  target_instance 
) [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.

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::finder_event_observer_0_1_xrl_target_death ( const string &  target_class,
const string &  target_instance 
) [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.

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::finder_event_observer_0_1_xrl_target_death ( const string &  target_class,
const string &  target_instance 
) [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.

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::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 
) [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.

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::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 
) [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.

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::redist4_0_1_finishing_route_dump ( const string &  cookie) [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.

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::redist4_0_1_finishing_route_dump ( const string &  cookie) [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.

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::redist4_0_1_starting_route_dump ( const string &  cookie) [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.

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::redist4_0_1_starting_route_dump ( const string &  cookie) [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.

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::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 
) [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.

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::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 
) [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.

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::redist6_0_1_finishing_route_dump ( const string &  cookie) [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.

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::redist6_0_1_finishing_route_dump ( const string &  cookie) [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.

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::redist6_0_1_starting_route_dump ( const string &  cookie) [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.

Implemented in ShowRoutesProcessor.

virtual XrlCmdError XrlShowRoutesTargetBase::redist6_0_1_starting_route_dump ( const string &  cookie) [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.

Implemented in ShowRoutesProcessor.

bool XrlShowRoutesTargetBase::set_command_map ( XrlCmdMap cmds)

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.
bool XrlShowRoutesTargetBase::set_command_map ( XrlCmdMap cmds)

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.

The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations