org.onosproject.incubator.net.routing.impl

Class RouteManager

java.lang.Object

org.onosproject.incubator.net.routing.impl.RouteManager

All Implemented Interfaces:

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

@Service
public class RouteManager
extends java.lang.Object
implements RouteService, RouteAdminService

Implementation of the unicast route service.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.net.host.HostService	hostService
protected RouteStore	routeStore

Constructor Summary

Constructors

Constructor and Description
RouteManager()

Method Summary

Modifier and Type	Method and Description
protected void	activate()
void	addListener(RouteListener listener) In a departure from other services in ONOS, calling addListener will cause all current routes to be pushed to the listener before any new events are sent.
protected void	deactivate()
java.util.Map<RouteTableId,java.util.Collection<Route>>	getAllRoutes() Returns all routes for all route tables in the system.
java.util.Set<NextHop>	getNextHops() Returns all next hops in the route store.
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) Returns the routes for the given next hop.
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) Performs a longest prefix match on the given IP address.
void	removeListener(RouteListener listener)
void	update(java.util.Collection<Route> routes) Updates the given routes in the route service.
void	withdraw(java.util.Collection<Route> routes) Withdraws the given routes from the route service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

routeStore

@Reference(cardinality=MANDATORY_UNARY)
protected RouteStore routeStore

hostService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.net.host.HostService hostService

Constructor Detail

RouteManager

public RouteManager()

Method Detail

activate

@Activate
protected void activate()

deactivate

@Deactivate
protected void deactivate()

addListener

public void addListener(RouteListener listener)

In a departure from other services in ONOS, calling addListener will cause all current routes to be pushed to the listener before any new events are sent. This allows a listener to easily get the exact set of routes without worrying about missing any.

Specified by:

addListener in interface org.onosproject.event.ListenerService<RouteEvent,RouteListener>

Parameters:

listener - listener to be added

removeListener

public void removeListener(RouteListener listener)

Specified by:

removeListener in interface org.onosproject.event.ListenerService<RouteEvent,RouteListener>

getAllRoutes

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

Description copied from interface: RouteService

Returns all routes for all route tables in the system.

Specified by:

getAllRoutes in interface RouteService

Returns:

map of route table name to routes in that table

getRouteTables

public java.util.Collection<RouteTableId> getRouteTables()

Description copied from interface: RouteService

Returns the set of route tables in the system.

Specified by:

getRouteTables in interface RouteService

Returns:

collection of route table IDs.

getRoutes

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

Description copied from interface: RouteService

Returns information about all routes in the given route table.

Specified by:

getRoutes in interface RouteService

Parameters:

id - route table ID

Returns:

collection of route information

longestPrefixMatch

public Route longestPrefixMatch(org.onlab.packet.IpAddress ip)

Description copied from interface: RouteService

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.

Specified by:

longestPrefixMatch in interface RouteService

Parameters:

ip - IP address

Returns:

longest prefix matched route

longestPrefixLookup

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

Description copied from interface: RouteService

Performs a longest prefix lookup on the given IP address.

Specified by:

longestPrefixLookup in interface RouteService

Parameters:

ip - IP address to look up

Returns:

most specific matching route, if one exists

getRoutesForNextHop

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

Description copied from interface: RouteService

Returns the routes for the given next hop.

Specified by:

getRoutesForNextHop in interface RouteService

Parameters:

nextHop - next hop IP address

Returns:

routes for this next hop

getNextHops

public java.util.Set<NextHop> getNextHops()

Description copied from interface: RouteService

Returns all next hops in the route store.

Specified by:

getNextHops in interface RouteService

Returns:

set of next hops

update

public void update(java.util.Collection<Route> routes)

Description copied from interface: RouteAdminService

Updates the given routes in the route service.

Specified by:

update in interface RouteAdminService

Parameters:

routes - collection of routes to update

withdraw

public void withdraw(java.util.Collection<Route> routes)

Description copied from interface: RouteAdminService

Withdraws the given routes from the route service.

Specified by:

withdraw in interface RouteAdminService

Parameters:

routes - collection of routes to withdraw