-
/*
* Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
*
package org.opendaylight.controller.sal.topology;
-import java.util.Set;
-
+import java.util.List;
import org.opendaylight.controller.sal.core.Edge;
-import org.opendaylight.controller.sal.core.Property;
-import org.opendaylight.controller.sal.core.UpdateType;
/**
- * @file IPluginOutTopologyService.java
- *
- * @brief Methods that are invoked from Protocol Plugin toward SAL
- *
- * Every time a protocol plugin update the topology, it will call this
- * service provided by SAL so the update can migrate upward toward the
- * applications
- */
-
-/**
- * Methods that are invoked from Protocol Plugin toward SAL
- *
+ * This interface defines the methods that are invoked from Protocol Plugin
+ * toward SAL. Every time a protocol plugin update the topology, it will call
+ * this service provided by SAL so the update can migrate upward toward the
+ * applications.
*/
public interface IPluginOutTopologyService {
+
/**
* Called to update on Edge in the topology graph
*
- * @param e Edge being updated
- * @param type Type of update
- * @param props Properties of the edge, like BandWidth and/or Latency etc.
+ * @param topoedgeupdateList
+ * List of topoedgeupdates Each topoedgeupdate includes edge, its
+ * Properties ( BandWidth and/or Latency etc) and update type.
*/
- public void edgeUpdate(Edge e, UpdateType type, Set<Property> props);
+ public void edgeUpdate(List<TopoEdgeUpdate> topoedgeupdateList);
/**
- * Called when an Edge utilization is above the safety threshold
- * configured on the controller
- *
+ * Called when an Edge utilization is above the safety threshold configured
+ * on the controller
+ *
* @param edge
- */
+ * The edge which bandwidth usage is above the safety level
+ */
public void edgeOverUtilized(Edge edge);
/**
* threshold level configured on the controller
*
* @param edge
+ * The edge which bandwidth usage is back to normal
*/
public void edgeUtilBackToNormal(Edge edge);
}