|
| ||||||||||||||||
| XrlCmdMap* _cmds | _cmds |
[protected]
| XrlStaticRoutesTargetBase (XrlCmdMap* cmds = 0)
| XrlStaticRoutesTargetBase |
Constructor.
Parameters:
| cmds | an XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target. |
| ~XrlStaticRoutesTargetBase ()
| ~XrlStaticRoutesTargetBase |
[virtual]
Destructor.
Dissociates instance commands from command map.
| bool set_command_map (XrlCmdMap* cmds)
| set_command_map |
Set command map.
Parameters:
| cmds | pointer 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:
| 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:
| 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_class | the target class name. |
| target_instance | the 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_class | the target class name. |
| target_instance | the 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:
| filter | the identifier of the filter to configure. |
| conf | the 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:
| filter | the 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 static_routes_0_1_enable_static_routes (
const bool& enable)
| static_routes_0_1_enable_static_routes |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable/start/stop StaticRoutes.
Parameters:
| enable | if true, then enable StaticRoutes, otherwise disable it. |
| XrlCmdError static_routes_0_1_start_static_routes ()
| static_routes_0_1_start_static_routes |
[protected pure virtual]
| XrlCmdError static_routes_0_1_stop_static_routes ()
| static_routes_0_1_stop_static_routes |
[protected pure virtual]
| XrlCmdError static_routes_0_1_add_route4 (
const bool& unicast,
const bool& multicast,
const IPv4Net& network,
const IPv4& nexthop,
const uint32_t& metric)
| static_routes_0_1_add_route4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add/replace/delete a static route.
Parameters:
| unicast | if true, then the route would be used for unicast routing. |
| multicast | if true, then the route would be used in the MRIB (Multicast Routing Information Base) for multicast purpose (e.g., computing the Reverse-Path Forwarding information). |
| network | the network address prefix this route applies to. |
| nexthop | the address of the next-hop router for this route. |
| metric | the metric distance for this route. |
| XrlCmdError static_routes_0_1_add_route6 (
const bool& unicast,
const bool& multicast,
const IPv6Net& network,
const IPv6& nexthop,
const uint32_t& metric)
| static_routes_0_1_add_route6 |
[protected pure virtual]
| XrlCmdError static_routes_0_1_replace_route4 (
const bool& unicast,
const bool& multicast,
const IPv4Net& network,
const IPv4& nexthop,
const uint32_t& metric)
| static_routes_0_1_replace_route4 |
[protected pure virtual]
| XrlCmdError static_routes_0_1_replace_route6 (
const bool& unicast,
const bool& multicast,
const IPv6Net& network,
const IPv6& nexthop,
const uint32_t& metric)
| static_routes_0_1_replace_route6 |
[protected pure virtual]
| XrlCmdError static_routes_0_1_delete_route4 (
const bool& unicast,
const bool& multicast,
const IPv4Net& network)
| static_routes_0_1_delete_route4 |
[protected pure virtual]
| XrlCmdError static_routes_0_1_delete_route6 (
const bool& unicast,
const bool& multicast,
const IPv6Net& network)
| static_routes_0_1_delete_route6 |
[protected pure virtual]
| XrlCmdError static_routes_0_1_add_interface_route4 (
const bool& unicast,
const bool& multicast,
const IPv4Net& network,
const IPv4& nexthop,
const string& ifname,
const string& vifname,
const uint32_t& metric)
| static_routes_0_1_add_interface_route4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add/replace a static route by explicitly specifying the network interface toward the destination.
Parameters:
| unicast | if true, then the route would be used for unicast routing. |
| multicast | if true, then the route would be used in the MRIB (Multicast Routing Information Base) for multicast purpose (e.g., computing the Reverse-Path Forwarding information). |
| network | the network address prefix this route applies to. |
| nexthop | the address of the next-hop router for this route. |
| ifname | of the name of the physical interface toward the destination. |
| vifname | of the name of the virtual interface toward the destination. |
| metric | the metric distance for this route. |
| XrlCmdError static_routes_0_1_add_interface_route6 (
const bool& unicast,
const bool& multicast,
const IPv6Net& network,
const IPv6& nexthop,
const string& ifname,
const string& vifname,
const uint32_t& metric)
| static_routes_0_1_add_interface_route6 |
[protected pure virtual]
| XrlCmdError static_routes_0_1_replace_interface_route4 (
const bool& unicast,
const bool& multicast,
const IPv4Net& network,
const IPv4& nexthop,
const string& ifname,
const string& vifname,
const uint32_t& metric)
| static_routes_0_1_replace_interface_route4 |
[protected pure virtual]
| XrlCmdError static_routes_0_1_replace_interface_route6 (
const bool& unicast,
const bool& multicast,
const IPv6Net& network,
const IPv6& nexthop,
const string& ifname,
const string& vifname,
const uint32_t& metric)
| static_routes_0_1_replace_interface_route6 |
[protected pure virtual]
| XrlCmdError static_routes_0_1_enable_log_trace_all (
const bool& enable)
| static_routes_0_1_enable_log_trace_all |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable the StaticRoutes trace log for all operations.
Parameters:
| enable | if true, then enable the trace log, otherwise disable it. |
