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

Small clarifications to FlowRuleService javadocs.

Browse Source 
Change-Id: If15f4e1818542f07a3653416ced85cdd3fe01277
This commit is contained in:
Jonathan Hart 2016-05-23 15:41:11 -07:00
parent fc247f4048
commit 3fc7e83f5d
1 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
core/api/src/main/java/org/onosproject/net/flow/FlowRuleService.java
View File

@ -51,8 +51,6 @@ public interface FlowRuleService
*/ */
Iterable<FlowEntry> getFlowEntries(DeviceId deviceId); Iterable<FlowEntry> getFlowEntries(DeviceId deviceId);
// TODO: add createFlowRule factory method and execute operations method
/** /**
* Applies the specified flow rules onto their respective devices. These * Applies the specified flow rules onto their respective devices. These
* flow rules will be retained by the system and re-applied anytime the * flow rules will be retained by the system and re-applied anytime the
@ -68,22 +66,20 @@ public interface FlowRuleService
* be removed once the device reconnects. * be removed once the device reconnects.
* *
* @param flowRules one or more flow rules * @param flowRules one or more flow rules
* throws SomeKindOfException that indicates which ones were removed and
* which ones failed
*/ */
void removeFlowRules(FlowRule... flowRules); void removeFlowRules(FlowRule... flowRules);
/** /**
* Removes all rules by id. * Removes all rules submitted by a particular application.
* *
* @param appId id to remove * @param appId ID of application whose flows will be removed
*/ */
void removeFlowRulesById(ApplicationId appId); void removeFlowRulesById(ApplicationId appId);
/** /**
* Returns a list of rules with this application id. * Returns a list of rules with this application ID.
* *
* @param id the id to look up * @param id the application ID to look up
* @return collection of flow rules * @return collection of flow rules
*/ */
Iterable<FlowRule> getFlowRulesById(ApplicationId id); Iterable<FlowRule> getFlowRulesById(ApplicationId id);