OpenFLow plugin & SAL API documentation

[controller.git] / opendaylight / sal / api / src / main / java / org / opendaylight / controller / sal / reader / IReadService.java

diff --git a/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/reader/IReadService.java b/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/reader/IReadService.java
index ae975f1a58d21c7d30b52f7e878b48db4db905f0..c3af91dd345035549e5138dbf4c1fd788ca18f35 100644 (file)
--- a/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/reader/IReadService.java
+++ b/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/reader/IReadService.java
@@ -17,17 +17,23 @@ import org.opendaylight.controller.sal.core.NodeTable;
 import org.opendaylight.controller.sal.flowprogrammer.Flow;
 
 /**
- * Interface for retrieving the network node's flow/port/queue hardware view
- *
- *
- *
+ * This interface defines methods for retrieving the network node's
+ * flow/port/queue hardware view
  */
 public interface IReadService {
     /**
-     * Get the hardware view for the specified flow on the specified network node
+     * Get the hardware view for the specified flow on the specified network
+     * node
      *
      * @param node
+     *            the network node
+     *            {@link org.opendaylight.controller.sal.core.Node}
      * @param flow
+     *            the given flow
+     *            {@link org.opendaylight.controller.sal.flowprogrammer.Flow}
+     * @return the flow
+     *         {@link org.opendaylight.controller.sal.reader.FlowOnNode}
+     *         installed on the node
      */
     FlowOnNode readFlow(Node node, Flow flow);
 
@@ -37,7 +43,14 @@ public interface IReadService {
      * Caller will be blocked until node replies or request times out
      *
      * @param node
+     *            the network node
+     *            {@link org.opendaylight.controller.sal.core.Node}
      * @param flow
+     *            the given flow
+     *            {@link org.opendaylight.controller.sal.flowprogrammer.Flow}
+     * @return the flow
+     *         {@link org.opendaylight.controller.sal.reader.FlowOnNode}
+     *         installed on the node
      */
     FlowOnNode nonCachedReadFlow(Node node, Flow flow);
 
@@ -45,7 +58,11 @@ public interface IReadService {
      * Get the hardware view for all the flows installed on the network node
      *
      * @param node
-     * @return
+     *            the network node
+     *            {@link org.opendaylight.controller.sal.core.Node}
+     * @return all the flows
+     *         {@link org.opendaylight.controller.sal.reader.FlowOnNode}
+     *         installed on the node
      */
     List<FlowOnNode> readAllFlows(Node node);
 
@@ -55,14 +72,22 @@ public interface IReadService {
      * Caller will be blocked until node replies or request times out
      *
      * @param node
-     * @param flow
+     *            the network node
+     *            {@link org.opendaylight.controller.sal.core.Node}
+     * @return the hardware view of all the flows
+     *         {@link org.opendaylight.controller.sal.reader.FlowOnNode}
+     *         installed on the node
      */
     List<FlowOnNode> nonCachedReadAllFlows(Node node);
 
     /**
      * Get the description information for the network node
+     *
      * @param node
-     * @return
+     *            the network node
+     *            {@link org.opendaylight.controller.sal.core.Node}
+     * @return the node description
+     *         {@link org.opendaylight.controller.sal.reader.NodeDescription}
      */
     NodeDescription readDescription(Node node);
 
@@ -72,33 +97,57 @@ public interface IReadService {
      * Caller will be blocked until node replies or request times out
      *
      * @param node
-     * @return
+     *            the network node
+     *            {@link org.opendaylight.controller.sal.core.Node}
+     * @return the node description
+     *         {@link org.opendaylight.controller.sal.reader.NodeDescription}
      */
     NodeDescription nonCachedReadDescription(Node node);
 
     /**
      * Get the hardware view for the specified node connector
+     *
      * @param connector
+     *            the given node connector
+     *            {@link org.opendaylight.controller.sal.core.NodeConnector}
+     * @return the node connector statistics
+     *         {@link org.opendaylight.controller.sal.reader.NodeConnectorStatistics}
      */
     NodeConnectorStatistics readNodeConnector(NodeConnector connector);
 
     /**
      * Get the hardware view for all the node connectors
      * present on the specified network node
-     * @param connector
+     *
+     * @param node
+     *            the network node
+     *            {@link org.opendaylight.controller.sal.core.Node}
+     * @return the statistics for all the node connectors
+     *         {@link org.opendaylight.controller.sal.reader.NodeConnectorStatistics}
      */
     List<NodeConnectorStatistics> readNodeConnectors(Node node);
 
     /**
      * Read the Table statistics for the given node table
+     *
      * @param table
+     *            the table
+     *            {@link org.opendaylight.controller.sal.core.NodeTable}
+     * @return the table statistics
+     *         {@link org.opendaylight.controller.sal.reader.NodeTableStatistics}
      */
     NodeTableStatistics readNodeTable(NodeTable table);
 
     /**
-     * Read the Table statistics for the given node
-     * This is not used. Querying all tables on a node is not currently a feature.
-     * @param table
+     * Read the Table statistics for the given node This is not used. Querying
+     * all tables on a node is not currently a feature.
+     *
+     * @param node
+     *            the network node
+     *            {@link org.opendaylight.controller.sal.core.Node}
+     * @return the table statistics
+     *         {@link org.opendaylight.controller.sal.reader.NodeTableStatistics}
+     *         for all tables in a given node
      */
     List<NodeTableStatistics> readNodeTable(Node node);
 
@@ -108,6 +157,10 @@ public interface IReadService {
      * Caller will be blocked until the node replies or request times out
      *
      * @param table
+     *            the table
+     *            {@link org.opendaylight.controller.sal.core.NodeTable}
+     * @return the table statistics
+     *         {@link org.opendaylight.controller.sal.reader.NodeTableStatistics}
      */
     NodeTableStatistics nonCachedReadNodeTable(NodeTable table);
 
@@ -117,15 +170,22 @@ public interface IReadService {
      * Caller will be blocked until node replies or request times out
      *
      * @param node
-     * @return
+     *            the network node
+     *            {@link org.opendaylight.controller.sal.core.Node}
+     * @return the statistics
+     *         {@link org.opendaylight.controller.sal.reader.NodeConnectorStatistics}
+     *         for all node connectors in a given node
      */
     List<NodeConnectorStatistics> nonCachedReadNodeConnectors(Node node);
 
     /**
      * Get the node connectors statistics information for the network node
      *
-     * @param node
-     * @return
+     * @param connector
+     *            the given node connector
+     *            {@link org.opendaylight.controller.sal.core.NodeConnector}
+     * @return the node connector statistics
+     *         {@link org.opendaylight.controller.sal.reader.NodeConnectorStatistics}
      */
     NodeConnectorStatistics nonCachedReadNodeConnector(NodeConnector connector);
 
@@ -133,6 +193,8 @@ public interface IReadService {
      * Get the transmit rate for the specified node connector
      *
      * @param connector
+     *            the given node connector
+     *            {@link org.opendaylight.controller.sal.core.NodeConnector}
      * @return tx rate [bps]
      */
     long getTransmitRate(NodeConnector connector);