diff --git a/src/main/java/net/floodlightcontroller/routing/IRoutingService.java b/src/main/java/net/floodlightcontroller/routing/IRoutingService.java index 93882973ed77caa75586c3f2ae1696fc0a34c816..63b5d1856b00820f5558315d068655b4f3fb459f 100644 --- a/src/main/java/net/floodlightcontroller/routing/IRoutingService.java +++ b/src/main/java/net/floodlightcontroller/routing/IRoutingService.java @@ -24,17 +24,47 @@ import net.floodlightcontroller.routing.Route; public interface IRoutingService extends IFloodlightService { - /** Provides a route between src and dst that allows tunnels. */ + /** + * Provides a route between src and dst that allows tunnels. The cookie is provisioned + * for callers of getRoute to provide additional information to influence the route + * to be returned, if the underlying routing implementation supports choice among + * multiple routes. + * @param src Source switch DPID. + * @param dst Destination switch DPID. + * @param cookie cookie (usage determined by implementation; ignored by topology instance now). + */ public Route getRoute(long src, long dst, long cookie); - /** Provides a route between src and dst, with option to allow or - * not allow tunnels in the path.*/ + /** + * Provides a route between src and dst, with option to allow or + * not allow tunnels in the path. + * @param src Source switch DPID. + * @param dst Destination switch DPID. + * @param cookie cookie (usage determined by implementation; ignored by topology instance now). + * @param tunnelEnabled boolean option. + */ public Route getRoute(long src, long dst, long cookie, boolean tunnelEnabled); - + /** + * Provides a route between srcPort on src and dstPort on dst. + * @param src Source switch DPID. + * @param srcPort Source port on source switch. + * @param dst Destination switch DPID. + * @param dstPort dstPort on Destination switch. + * @param cookie cookie (usage determined by implementation; ignored by topology instance now). + */ public Route getRoute(long srcId, short srcPort, long dstId, short dstPort, long cookie); + /** + * Provides a route between srcPort on src and dstPort on dst. + * @param src Source switch DPID. + * @param srcPort Source port on source switch. + * @param dst Destination switch DPID. + * @param dstPort dstPort on Destination switch. + * @param cookie cookie (usage determined by implementation; ignored by topology instance now). + * @param tunnelEnabled boolean option. + */ public Route getRoute(long srcId, short srcPort, long dstId, short dstPort, long cookie, boolean tunnelEnabled);