net.floodlightcontroller.routing

Interface IRoutingService

All Superinterfaces:

IFloodlightService

All Known Subinterfaces:

ITopologyPathFinding

All Known Implementing Classes:

RoutingManager

public interface IRoutingService
extends IFloodlightService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IRoutingService.PATH_METRIC The metric used to compute paths across the topology

Method Summary

Modifier and Type	Method and Description
void	addRoutingDecisionChangedListener(IRoutingDecisionChangedListener listener) Register the RDCListener
boolean	forceRecompute() Recompute paths now, regardless of whether or not there was a change in the topology.
int	getMaxPathsToCompute() Get the max paths that are computed by default (fast).
Path	getPath(org.projectfloodlight.openflow.types.DatapathId src, org.projectfloodlight.openflow.types.DatapathId dst) Locates a path between src and dst
Path	getPath(org.projectfloodlight.openflow.types.DatapathId src, org.projectfloodlight.openflow.types.OFPort srcPort, org.projectfloodlight.openflow.types.DatapathId dst, org.projectfloodlight.openflow.types.OFPort dstPort) Provides a path between srcPort on src and dstPort on dst.
IRoutingService.PATH_METRIC	getPathMetric() Get the metric being used to compute paths across the topology.
java.util.List<Path>	getPathsFast(org.projectfloodlight.openflow.types.DatapathId src, org.projectfloodlight.openflow.types.DatapathId dst) Return all possible paths up to quantity of the globally configured max.
java.util.List<Path>	getPathsFast(org.projectfloodlight.openflow.types.DatapathId src, org.projectfloodlight.openflow.types.DatapathId dst, int numReqPaths) This function returns K number of paths between a source and destination **if they exist in the pathcache**.
java.util.List<Path>	getPathsSlow(org.projectfloodlight.openflow.types.DatapathId src, org.projectfloodlight.openflow.types.DatapathId dst, int numReqPaths) This function returns K number of paths between a source and destination.
void	handleRoutingDecisionChange(java.lang.Iterable<org.projectfloodlight.openflow.types.Masked<org.projectfloodlight.openflow.types.U64>> changedDecisions) Notifies listeners that routing logic has changed, requiring certain past routing decisions to become invalid.
boolean	pathExists(org.projectfloodlight.openflow.types.DatapathId src, org.projectfloodlight.openflow.types.DatapathId dst) Check if a path exists between src and dst
void	removeRoutingDecisionChangedListener(IRoutingDecisionChangedListener listener) Remove the RDCListener
void	setMaxPathsToCompute(int max) Do not compute more than max paths by default (fast).
void	setPathMetric(IRoutingService.PATH_METRIC metric) Set the metric used when computing paths across the topology.

Method Detail

setPathMetric

void setPathMetric(IRoutingService.PATH_METRIC metric)

Set the metric used when computing paths across the topology.

Parameters:

metric -

getPathMetric

IRoutingService.PATH_METRIC getPathMetric()

Get the metric being used to compute paths across the topology.

Returns:

addRoutingDecisionChangedListener

void addRoutingDecisionChangedListener(IRoutingDecisionChangedListener listener)

Register the RDCListener

Parameters:

listener - - The module that wants to listen for events

removeRoutingDecisionChangedListener

void removeRoutingDecisionChangedListener(IRoutingDecisionChangedListener listener)

Remove the RDCListener

Parameters:

listener - - The module that wants to stop listening for events

handleRoutingDecisionChange

void handleRoutingDecisionChange(java.lang.Iterable<org.projectfloodlight.openflow.types.Masked<org.projectfloodlight.openflow.types.U64>> changedDecisions)

Notifies listeners that routing logic has changed, requiring certain past routing decisions to become invalid. The caller provides a sequence of masked values that match against past values of IRoutingDecision.getDescriptor(). Services that have operated on past routing decisions are then able to remove the results of past decisions, normally by deleting flows.

Parameters:

changedDecisions - Masked descriptors identifying routing decisions that are now obsolete or invalid

setMaxPathsToCompute

void setMaxPathsToCompute(int max)

Do not compute more than max paths by default (fast).

Parameters:

max -

getMaxPathsToCompute

int getMaxPathsToCompute()

Get the max paths that are computed by default (fast).

Returns:

pathExists

boolean pathExists(org.projectfloodlight.openflow.types.DatapathId src,
                   org.projectfloodlight.openflow.types.DatapathId dst)

Check if a path exists between src and dst

Parameters:

src - source switch

dst - destination switch

Returns:

true if a path exists; false otherwise

getPath

Path getPath(org.projectfloodlight.openflow.types.DatapathId src,
             org.projectfloodlight.openflow.types.DatapathId dst)

Locates a path between src and dst

Parameters:

src - source switch

dst - destination switch

Returns:

the lowest cost path

getPath

Path getPath(org.projectfloodlight.openflow.types.DatapathId src,
             org.projectfloodlight.openflow.types.OFPort srcPort,
             org.projectfloodlight.openflow.types.DatapathId dst,
             org.projectfloodlight.openflow.types.OFPort dstPort)

Provides a path between srcPort on src and dstPort on dst.

Parameters:

src - source switch

srcPort - source port on source switch

dst - destination switch

dstPort - destination port on destination switch

Returns:

the lowest cost path

getPathsFast

java.util.List<Path> getPathsFast(org.projectfloodlight.openflow.types.DatapathId src,
                                  org.projectfloodlight.openflow.types.DatapathId dst)

Return all possible paths up to quantity of the globally configured max.

Parameters:

src - source switch

dst - destination switch

Returns:

list of paths ordered least to greatest cost

getPathsFast

java.util.List<Path> getPathsFast(org.projectfloodlight.openflow.types.DatapathId src,
                                  org.projectfloodlight.openflow.types.DatapathId dst,
                                  int numReqPaths)

This function returns K number of paths between a source and destination **if they exist in the pathcache**. If the caller requests more paths than available, only the paths already stored in memory will be returned. See getPathsSlow(DatapathId, DatapathId, int) to compute additional paths in real-time. The number of paths returned will be the min(numReqPaths, maxConfig), where maxConfig is the configured ceiling on paths to precompute.

Parameters:

src - source switch

dst - destination switch

numReqPaths - the requested quantity of paths

Returns:

list of paths ordered least to greatest cost

getPathsSlow

java.util.List<Path> getPathsSlow(org.projectfloodlight.openflow.types.DatapathId src,
                                  org.projectfloodlight.openflow.types.DatapathId dst,
                                  int numReqPaths)

This function returns K number of paths between a source and destination. It will attempt to retrieve these paths from the pathcache. If the caller requests more paths than are stored, Yen's algorithm will be re-run in an attempt to located the desired quantity of paths (which can be expensive). See getPathsFast(DatapathId, DatapathId, int) or getPathsFast(DatapathId, DatapathId) to retrieve the precomputed paths without the risk of additional overhead. The number of paths returned will be the min(numReqPaths, availablePaths), where availablePaths is the permutation of all possible paths in the topology from src to dst.

Parameters:

src - source switch

dst - destination switch

numReqPaths - the requested quantity of paths

Returns:

list of paths ordered least to greatest cost

forceRecompute

boolean forceRecompute()

Recompute paths now, regardless of whether or not there was a change in the topology. This should be called if setPathMetric(PATH_METRIC) was invoked to change the PATH_METRIC **and we want the new metric to take effect now** for future getPathsFast() or getPath() function calls. This will allow other modules using IRoutingService path-finding to use paths based on the new metric if the other modules only use the "fast" path-finding API. One can use getPathsSlow(DatapathId, DatapathId, int) if there is no urgency for the new metric to take effect and yet one would still like to see the paths using the new metric once or so. In this case, one need not invoke forceRecompute().

Returns:

true upon success; false otherwise