Home | Trees | Indices | Help |
|
---|
|
This class represents an application route table. It provides application the ability to add, remove and replace route from the application route table. The following services are provided:
Add, replace and remove route from the application route table.Get notification when the added application route is promoted or demoted in the RIB.
Depending on platform, the application route table could do extra check before adding the route to the RIB. For example, route may be added to the RIB when the next hop is resolvable.
Once the application accept and return success for the operation, the application is responsible to keep the state of the routes consistent across HA switchover.
The route added will not be visible in the configuration. But the added route would be visible in routing related show commands. The show output will be able to tell which application added the route. The added route are redistributable.
If a listener is registered, the application route table will provide notification when an application route gets promoted or demoted in the RIB.
Currently, only add/delete/update route operations are supported.
Instance Methods | |||
list of L3UnicastRouteOperation
|
|
||
int
|
|
||
int
|
|
||
|
|||
int
|
|
||
|
|||
Inherited from |
Class Variables | |
RouteState = enum('PROMOTE', 'DEMOTE') This enum represents a route state and support L2/L3 and IPv4/IPv6. |
|
TRIGER_INITIAL_WALK = 1
|
Properties | |
Inherited from |
Method Details |
Update a route. It is a synchronous API. It is used to add, delete and replace single route in the Application Route Table. The type of operation is indicated by RouteOperationType parameter. For route addition: If the route do not exist, create route with the provided next hops. If the route already exist in the table, any new next hop specified is added to the route. Duplicated next hop is ignored. For route replace: If the route do not exist, it act like route addition operation. If the route already exist in the table, the all the old next hops are removed and new next hops specified are added to the route. For route deletion: Next hop specified will be removed. If no next hop is specified, then all next hops are removed. The route will be removed when no more next hops exist. Return error if the scope and route is not consistent. This method will make remote procedure call and response time may be long.
|
Asynchronously update a route. It is an asynchronous API that will return immediately and the application provided listener will be invoked when the all the route update requests are processed by the network element. It is used to add, delete and replace single route in the Application Route Table. The type of operation is indicated by RouteOperationType parameter. For route addition: If the route do not exist, create route with the provided next hops. If the route already exist in the table, any new next hop specified is added to the route Duplicated next hop is ignored. For route replace: If the route do not exist, it act like route addition operation. If the route already exist in the table, the all the old next hops are removed and new next hops specified are added to the route. If no next hop is specified, then all next hops are removed. The route will be removed when no more next hops exist. Return error if the scope and route is not consistent. This method will make remote procedure call and response time may be long.
|
Adds a route state listener to the ART object.
|
Removes the RouteStateListener listener object. This method will remove the listener associated with the specified eventHandle and also remove the corresponding registered event on the route table.
|
Adds a replay route event listener to the RIB object.
|
Removes the ReplayRouteEventListener listener object. This method will remove the listener associated with the specified eventHandle and also remove the corresponding registered event on the route table.
|
Class Variable Details |
RouteStateThis enum represents a route state and support L2/L3 and IPv4/IPv6. Indicates the route becomes the best route in the RIB.'PROMOTE', Indicates the route is no longer the best route in the RIB.'DEMOTE'
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Mon Aug 18 09:17:33 2014 | http://epydoc.sourceforge.net |