opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/routing/IRouting.java

   1
   2 /*
   3  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   4  *
   5  * This program and the accompanying materials are made available under the
   6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   7  * and is available at http://www.eclipse.org/legal/epl-v10.html
   8  */
   9
  10 package org.opendaylight.controller.sal.routing;
  11
  12 import java.util.Map;
  13
  14 import org.opendaylight.controller.sal.core.Edge;
  15 import org.opendaylight.controller.sal.core.Node;
  16 import org.opendaylight.controller.sal.core.Path;
  17
  18 public interface IRouting {
  19
  20     /**
  21      * Returns a Path leading from the source to the destination
  22      * @param src: source Node
  23      * @param dst: destination Node
  24      * @return: Path
  25      */
  26     public Path getRoute(Node src, Node dst);
  27
  28     /**
  29      * Returns a Max ThroughPut Path leading from the source to the destination
  30      * @param src: source Node
  31      * @param dst: destination Node
  32      * @return: MTPath
  33      */
  34     public Path getMaxThroughputRoute(Node src, Node dst);
  35
  36     /**
  37      * Returns a Path leading from the source to the destination that meets the specified bandwidth
  38      * @param src: source Node
  39      * @param dst: destination Node
  40      * @param Bw: bandwidth
  41      * @return: Path
  42      */
  43     public Path getRoute(Node src, Node dst, Short Bw);
  44
  45     /**
  46      * Remove all routes and reset all state. USE CAREFULLY!
  47      */
  48     public void clear();
  49
  50     /**
  51      * Remove all Max Throughput Routes and reset all state. USE CAREFULLY!
  52      */
  53     public void clearMaxThroughput();
  54
  55     /**
  56      * Initialization For Max Throughput
  57      * @param EdgeWeightMap: Map containing Edge and Corresponding
  58      * Weight. Optional Param - if null, implementation specific weight
  59      * calculation will be used.
  60      */
  61     public void initMaxThroughput(Map<Edge, Number> EdgeWeightMap);
  62
  63 }