org.onosproject.incubator.net.routing.impl

Interface ResolvedRouteStore

All Known Implementing Classes:

DefaultResolvedRouteStore

public interface ResolvedRouteStore

Stores resolved routes and best route decisions.

Method Summary

Modifier and Type	Method and Description
Collection<ResolvedRoute>	getAllRoutes(org.onlab.packet.IpPrefix prefix) Returns all resolved routes stored for the given prefix, including the best selected route.
Optional<ResolvedRoute>	getRoute(org.onlab.packet.IpPrefix prefix) Returns the best selected route for the given IP prefix.
Collection<ResolvedRoute>	getRoutes(RouteTableId table) Returns the best routes for a give route table.
Set<RouteTableId>	getRouteTables() Gets the set of route tables.
Optional<ResolvedRoute>	longestPrefixMatch(org.onlab.packet.IpAddress ip) Performs a longest prefix match of the best routes on the given IP address.
RouteEvent	removeRoute(org.onlab.packet.IpPrefix prefix) Removes the best route for the given prefix.
RouteEvent	updateRoute(ResolvedRoute route, Set<ResolvedRoute> alternatives) Adds or updates the best route for the given prefix.

Method Detail

updateRoute

RouteEvent updateRoute(ResolvedRoute route,
                       Set<ResolvedRoute> alternatives)

Adds or updates the best route for the given prefix.

Parameters:

route - new best route for this prefix

alternatives - alternative resolved routes

Returns:

event describing the change

removeRoute

RouteEvent removeRoute(org.onlab.packet.IpPrefix prefix)

Removes the best route for the given prefix.

Parameters:

prefix - IP prefix

Returns:

event describing the change

getRouteTables

Set<RouteTableId> getRouteTables()

Gets the set of route tables.

Returns:

set of route table IDs

getRoutes

Collection<ResolvedRoute> getRoutes(RouteTableId table)

Returns the best routes for a give route table.

Parameters:

table - route table ID

Returns:

collection of selected routes

getRoute

Optional<ResolvedRoute> getRoute(org.onlab.packet.IpPrefix prefix)

Returns the best selected route for the given IP prefix.

Parameters:

prefix - IP prefix

Returns:

optional best route

getAllRoutes

Collection<ResolvedRoute> getAllRoutes(org.onlab.packet.IpPrefix prefix)

Returns all resolved routes stored for the given prefix, including the best selected route.

Parameters:

prefix - IP prefix to look up routes for

Returns:

all stored resolved routes for this prefix

longestPrefixMatch

Optional<ResolvedRoute> longestPrefixMatch(org.onlab.packet.IpAddress ip)

Performs a longest prefix match of the best routes on the given IP address.

Parameters:

ip - IP address

Returns:

optional longest matching route