|
| ||||||||||||||||
|
| ||||||||||||||||
There should be one node per StaticRoutes instance.
| StaticRoutesNode (EventLoop& eventloop)
| StaticRoutesNode |
Constructor for a given event loop.
Parameters:
| eventloop | the event loop to use. |
| ~StaticRoutesNode ()
| ~StaticRoutesNode |
[virtual]
| EventLoop& eventloop ()
| eventloop |
Get the event loop this node is added to.
Returns: the event loop this node is added to.
| const string& protocol_name ()
| protocol_name |
[const]
Get the protocol name.
Returns: a string with the protocol name.
| bool startup ()
| startup |
Startup the node operation.
Returns: true on success, false on failure.
Reimplemented from ServiceBase.
| bool shutdown ()
| shutdown |
Shutdown the node operation.
Returns: true on success, false on failure.
Reimplemented from ServiceBase.
| ProcessStatus node_status (string& reason_msg)
| node_status |
Get the node status (see ProcessStatus).
Parameters:
| reason_msg | return-by-reference string that contains human-readable information about the status. |
Returns: the node status (see ProcessStatus).
| bool is_done ()
| is_done |
[const]
Test if the node processing is done.
Returns: true if the node processing is done, otherwise false.
| int add_route4 (bool unicast, bool multicast,
const IPv4Net& network, const IPv4& nexthop,
const string& ifname, const string& vifname,
uint32_t metric, string& error_msg)
| add_route4 |
Add a static IPv4 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. |
| 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. |
| error_msg | the error message (if error). |
Returns: XORP_OK on success, otherwise XORP_ERROR.
| int add_route6 (bool unicast, bool multicast,
const IPv6Net& network, const IPv6& nexthop,
const string& ifname, const string& vifname,
uint32_t metric, string& error_msg)
| add_route6 |
Add a static IPv6 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. |
| 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. |
| error_msg | the error message (if error). |
Returns: XORP_OK on success, otherwise XORP_ERROR.
| int replace_route4 (bool unicast, bool multicast,
const IPv4Net& network, const IPv4& nexthop,
const string& ifname, const string& vifname,
uint32_t metric, string& error_msg)
| replace_route4 |
Replace a static IPv4 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. |
| 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. |
| error_msg | the error message (if error). |
Returns: XORP_OK on success, otherwise XORP_ERROR.
| int replace_route6 (bool unicast, bool multicast,
const IPv6Net& network, const IPv6& nexthop,
const string& ifname, const string& vifname,
uint32_t metric, string& error_msg)
| replace_route6 |
Replace a static IPv6 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. |
| 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. |
| error_msg | the error message (if error). |
Returns: XORP_OK on success, otherwise XORP_ERROR.
| int delete_route4 (bool unicast, bool multicast,
const IPv4Net& network, string& error_msg)
| delete_route4 |
Delete a static IPv4 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. |
| error_msg | the error message (if error). |
Returns: XORP_OK on success, otherwise XORP_ERROR.
| int delete_route6 (bool unicast, bool multicast,
const IPv6Net& network, string& error_msg)
| delete_route6 |
Delete a static IPv6 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. |
| error_msg | the error message (if error). |
Returns: XORP_OK on success, otherwise XORP_ERROR.
| bool is_log_trace ()
| is_log_trace |
[const]
Test if trace log is enabled.
This method is used to test whether to output trace log debug messges.
Returns: true if trace log is enabled, otherwise false.
| void set_log_trace (bool is_enabled)
| set_log_trace |
Enable/disable trace log.
This method is used to enable/disable trace log debug messages output.
Parameters:
| is_enabled | if true, trace log is enabled, otherwise is disabled. |
| void tree_complete ()
| tree_complete |
[protected]
Reimplemented from IfMgrHintObserver.
| void updates_made ()
| updates_made |
[protected]
Reimplemented from IfMgrHintObserver.
| void incr_startup_requests_n ()
| incr_startup_requests_n |
[protected]
| void decr_startup_requests_n ()
| decr_startup_requests_n |
[protected]
| void incr_shutdown_requests_n ()
| incr_shutdown_requests_n |
[protected]
| void decr_shutdown_requests_n ()
| decr_shutdown_requests_n |
[protected]
| void update_status ()
| update_status |
[protected]
