org.onosproject.incubator.net.routing

Interface RouteService

All Superinterfaces:

org.onosproject.event.ListenerService<RouteEvent,RouteListener>

All Known Subinterfaces:

RouteAdminService

public interface RouteService
extends org.onosproject.event.ListenerService<RouteEvent,RouteListener>

Unicast IP route service.

Method Summary

Modifier and Type	Method and Description
java.util.Map<RouteTableId,java.util.Collection<Route>>	getAllRoutes() Deprecated. in Kingfisher release. Use getRoutes(RouteTableId) instead.
java.util.Set<NextHop>	getNextHops() Deprecated.
java.util.Collection<RouteInfo>	getRoutes(RouteTableId id) Returns information about all routes in the given route table.
java.util.Collection<Route>	getRoutesForNextHop(org.onlab.packet.IpAddress nextHop) Deprecated.
java.util.Collection<RouteTableId>	getRouteTables() Returns the set of route tables in the system.
java.util.Optional<ResolvedRoute>	longestPrefixLookup(org.onlab.packet.IpAddress ip) Performs a longest prefix lookup on the given IP address.
Route	longestPrefixMatch(org.onlab.packet.IpAddress ip) Deprecated. in Kingfisher release. Use {longestPrefixLookup(IpAddress)} instead.

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Method Detail

getAllRoutes

@Deprecated
java.util.Map<RouteTableId,java.util.Collection<Route>> getAllRoutes()

Deprecated. in Kingfisher release. Use getRoutes(RouteTableId) instead.

Returns all routes for all route tables in the system.

Returns:

map of route table name to routes in that table

getRoutes

java.util.Collection<RouteInfo> getRoutes(RouteTableId id)

Returns information about all routes in the given route table.

Parameters:

id - route table ID

Returns:

collection of route information

getRouteTables

java.util.Collection<RouteTableId> getRouteTables()

Returns the set of route tables in the system.

Returns:

collection of route table IDs.

longestPrefixMatch

@Deprecated
Route longestPrefixMatch(org.onlab.packet.IpAddress ip)

Deprecated. in Kingfisher release. Use {longestPrefixLookup(IpAddress)} instead.

Performs a longest prefix match on the given IP address. The call will return the route with the most specific prefix that contains the given IP address.

Parameters:

ip - IP address

Returns:

longest prefix matched route

longestPrefixLookup

java.util.Optional<ResolvedRoute> longestPrefixLookup(org.onlab.packet.IpAddress ip)

Performs a longest prefix lookup on the given IP address.

Parameters:

ip - IP address to look up

Returns:

most specific matching route, if one exists

getRoutesForNextHop

@Deprecated
java.util.Collection<Route> getRoutesForNextHop(org.onlab.packet.IpAddress nextHop)

Deprecated.

Returns the routes for the given next hop.

Parameters:

nextHop - next hop IP address

Returns:

routes for this next hop

getNextHops

@Deprecated
java.util.Set<NextHop> getNextHops()

Deprecated.

Returns all next hops in the route store.

Returns:

set of next hops