X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fsal%2Fapi%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Freader%2FIPluginInReadService.java;h=e9efd382da09c35274c25cc613b6dd1c92fc8c5b;hb=7eb31665534a5e8c61b4cb4ae6caf4030a3dfd36;hp=c563037f1e6be9bce538780ba0dd8c93b2c3e31c;hpb=42210c03b0a4c54706320ba9f55794c0abd4d201;p=controller.git diff --git a/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/reader/IPluginInReadService.java b/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/reader/IPluginInReadService.java index c563037f1e..e9efd382da 100644 --- a/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/reader/IPluginInReadService.java +++ b/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/reader/IPluginInReadService.java @@ -13,60 +13,125 @@ import java.util.List; import org.opendaylight.controller.sal.core.Node; import org.opendaylight.controller.sal.core.NodeConnector; +import org.opendaylight.controller.sal.core.NodeTable; import org.opendaylight.controller.sal.flowprogrammer.Flow; /** - * @file IPluginInReadService.java - * - * @brief Hardware view interface to be implemented by protocol plugins - * - * - * + * The interface defines hardware view read methods to be implemented by protocol plugins */ public interface IPluginInReadService { /** - * Returns the hardware image for the specified flow on the specified network node + * Returns the hardware image for the specified flow on the specified + * network node + * * @param node + * the network node * @param flow - * @return + * the target flow + * @param cached + * specify if entry has to be queried from the cached hardware + * information maintained locally or directly from the network + * node. + * @return The FlowOnNode object containing the information present in + * hardware for the passed flow on the specified network node */ public FlowOnNode readFlow(Node node, Flow flow, boolean cached); /** - * Returns the hardware view of all the flow installed on the specified network node + * Returns the hardware view of all the flow installed on the specified + * network node + * * @param node - * @return + * the network node + * @param cached + * specify if entries have to be queried from the cached hardware + * information maintained locally or directly from the network + * node. + * @return The list of FlowOnNode objects containing the information present + * in hardware on the specified network node for all its flows */ public List readAllFlow(Node node, boolean cached); /** - * Returns the description of the network node as provided by the node itself + * Returns the description of the network node as provided by the node + * itself + * * @param node - * @return + * the network node + * @param cached + * specify if entry has to be queried from the cached hardware + * information maintained locally or directly from the network + * node. + * @return The NodeDescription object containing the description information + * for the specified network node */ public NodeDescription readDescription(Node node, boolean cached); /** * Returns the hardware view of the specified network node connector - * @param node - * @return + * + * @param connector + * the target nodeConnector + * @param cached + * specify if entry has to be queried from the cached hardware + * information maintained locally or directly from the + * corresponding network node. + * @return The NodeConnectorStatistics object containing the statistics + * present in hardware for the corresponding network node port */ public NodeConnectorStatistics readNodeConnector(NodeConnector connector, boolean cached); /** - * Returns the hardware info for all the node connectors on the specified network node + * Returns the hardware info for all the node connectors on the specified + * network node + * * @param node - * @return + * the target node + * @param cached + * specify if entries have to be queried from the cached hardware + * information maintained locally or directly from the + * corresponding network node. + * @return The list of NodeConnectorStatistics objects containing the + * statistics present in hardware for all the network node ports */ public List readAllNodeConnector(Node node, boolean cached); + /** + * Returns the table statistics for the node + * @param table + * the target network node table + * @param cached + * specify if entry has to be queried from the cached hardware + * information maintained locally or directly from + * the corresponding network node. + * @return The NodeTableStatistics object containing the statistics present + * in hardware for the corresponding network node table + */ + public NodeTableStatistics readNodeTable(NodeTable table, boolean cached); + + /** + * Returns all the table statistics for the node + * + * @param node + * the target node + * @param cached + * specify if entries have to be queried from the cached hardware + * information maintained locally or directly from the + * corresponding network node. + * @return The list of NodeTableStatistics objects containing the statistics + * present in hardware for all the network node tables + */ + public List readAllNodeTable(Node node, boolean cached); + /** * Returns the averaged transmit rate for the specified node connector * @param connector + * the target nodeConnector * @return tx rate [bps] */ public long getTransmitRate(NodeConnector connector); + }