mirrors/onos
1
0
Fork 0
mirror of https://github.com/opennetworkinglab/onos.git synced 2025-10-23 05:11:04 +02:00
Code Issues Projects Releases Wiki Activity

Follow the convention of javadoc used in the project

Browse Source 
Insert a blank line between the brief desciption and paramter description.

Change-Id: Iad27f20aa862f84a4278624f0df75f98ab9e543f
This commit is contained in:
Sho SHIMIZU 2014-11-13 17:34:46 -08:00 committed by Gerrit Code Review
parent 9e97826bb6
commit cf6090b691
3 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
core/api/src/main/java/org/onlab/onos/net/statistic/Load.java
View File

@ -22,24 +22,28 @@ public interface Load {
/** /**
* Obtain the current observed rate (in bytes/s) on a link. * Obtain the current observed rate (in bytes/s) on a link.
*
* @return long value * @return long value
*/ */
long rate(); long rate();
/** /**
* Obtain the latest bytes counter viewed on that link. * Obtain the latest bytes counter viewed on that link.
*
* @return long value * @return long value
*/ */
long latest(); long latest();
/** /**
* Indicates whether this load was built on valid values. * Indicates whether this load was built on valid values.
*
* @return boolean * @return boolean
*/ */
boolean isValid(); boolean isValid();
/** /**
* Returns when this value was seen. * Returns when this value was seen.
*
* @return epoch time * @return epoch time
*/ */
long time(); long time();

5
core/api/src/main/java/org/onlab/onos/net/statistic/StatisticService.java
View File

@ -29,6 +29,7 @@ public interface StatisticService {
/** /**
* Obtain the load for a the ingress to the given link. * Obtain the load for a the ingress to the given link.
*
* @param link the link to query. * @param link the link to query.
* @return a {@link org.onlab.onos.net.statistic.Load Load} * @return a {@link org.onlab.onos.net.statistic.Load Load}
*/ */
@ -36,6 +37,7 @@ public interface StatisticService {
/** /**
* Obtain the load for the given port. * Obtain the load for the given port.
*
* @param connectPoint the port to query * @param connectPoint the port to query
* @return a {@link org.onlab.onos.net.statistic.Load} * @return a {@link org.onlab.onos.net.statistic.Load}
*/ */
@ -43,6 +45,7 @@ public interface StatisticService {
/** /**
* Find the most loaded link along a path. * Find the most loaded link along a path.
*
* @param path the path to search in * @param path the path to search in
* @return the most loaded {@link org.onlab.onos.net.Link}. * @return the most loaded {@link org.onlab.onos.net.Link}.
*/ */
@ -50,6 +53,7 @@ public interface StatisticService {
/** /**
* Find the least loaded link along a path. * Find the least loaded link along a path.
*
* @param path the path to search in * @param path the path to search in
* @return the least loaded {@link org.onlab.onos.net.Link}. * @return the least loaded {@link org.onlab.onos.net.Link}.
*/ */
@ -58,6 +62,7 @@ public interface StatisticService {
/** /**
* Returns the highest hitter (a flow rule) for a given port, ie. the * Returns the highest hitter (a flow rule) for a given port, ie. the
* flow rule which is generating the most load. * flow rule which is generating the most load.
*
* @param connectPoint the port * @param connectPoint the port
* @return the flow rule * @return the flow rule
*/ */

5
core/api/src/main/java/org/onlab/onos/net/statistic/StatisticStore.java
View File

@ -28,24 +28,28 @@ public interface StatisticStore {
/** /**
* Lay the foundation for receiving flow stats for this rule. * Lay the foundation for receiving flow stats for this rule.
*
* @param rule a {@link org.onlab.onos.net.flow.FlowRule} * @param rule a {@link org.onlab.onos.net.flow.FlowRule}
*/ */
void prepareForStatistics(FlowRule rule); void prepareForStatistics(FlowRule rule);
/** /**
* Remove entries associated with this rule. * Remove entries associated with this rule.
*
* @param rule {@link org.onlab.onos.net.flow.FlowRule} * @param rule {@link org.onlab.onos.net.flow.FlowRule}
*/ */
void removeFromStatistics(FlowRule rule); void removeFromStatistics(FlowRule rule);
/** /**
* Adds a stats observation for a flow rule. * Adds a stats observation for a flow rule.
*
* @param rule a {@link org.onlab.onos.net.flow.FlowEntry} * @param rule a {@link org.onlab.onos.net.flow.FlowEntry}
*/ */
void addOrUpdateStatistic(FlowEntry rule); void addOrUpdateStatistic(FlowEntry rule);
/** /**
* Fetches the current observed stats values. * Fetches the current observed stats values.
*
* @param connectPoint the port to fetch information for * @param connectPoint the port to fetch information for
* @return set of current flow rules * @return set of current flow rules
*/ */
@ -53,6 +57,7 @@ public interface StatisticStore {
/** /**
* Fetches the current observed stats values. * Fetches the current observed stats values.
*
* @param connectPoint the port to fetch information for * @param connectPoint the port to fetch information for
* @return set of current values * @return set of current values
*/ */