Toshio Koide | a03915e | 2014-07-01 18:39:52 -0700 | [diff] [blame] | 1 | package net.onrc.onos.api.flowmanager; |
| 2 | |
Toshio Koide | fad1cd5 | 2014-08-07 17:10:07 -0700 | [diff] [blame] | 3 | import net.onrc.onos.api.batchoperation.BatchOperationTarget; |
Ray Milkey | 42ae1b5 | 2014-08-15 16:37:06 -0700 | [diff] [blame] | 4 | import net.onrc.onos.core.matchaction.MatchActionOperations; |
Toshio Koide | d8b077a | 2014-08-13 10:47:21 -0700 | [diff] [blame] | 5 | import net.onrc.onos.core.matchaction.match.Match; |
Toshio Koide | a03915e | 2014-07-01 18:39:52 -0700 | [diff] [blame] | 6 | |
| 7 | /** |
| 8 | * An interface class to define flow object which is managed by |
| 9 | * FlowManagerModule. |
| 10 | * <p> |
| 11 | * The flow objects (eg. path, tree, disjoint-paths, etc.) must implement this |
| 12 | * interface. |
| 13 | */ |
Toshio Koide | fad1cd5 | 2014-08-07 17:10:07 -0700 | [diff] [blame] | 14 | public interface Flow extends BatchOperationTarget { |
Toshio Koide | a03915e | 2014-07-01 18:39:52 -0700 | [diff] [blame] | 15 | /** |
| 16 | * Gets ID for this flow object. |
| 17 | * |
| 18 | * @return ID for this object. |
| 19 | */ |
Toshio Koide | 025a915 | 2014-07-21 11:00:34 -0700 | [diff] [blame] | 20 | public FlowId getId(); |
Toshio Koide | a03915e | 2014-07-01 18:39:52 -0700 | [diff] [blame] | 21 | |
| 22 | /** |
| 23 | * Gets traffic filter for this flow object. |
| 24 | * |
| 25 | * @return a traffic filter for this flow object. |
| 26 | */ |
Toshio Koide | d8b077a | 2014-08-13 10:47:21 -0700 | [diff] [blame] | 27 | public Match getMatch(); |
Toshio Koide | a03915e | 2014-07-01 18:39:52 -0700 | [diff] [blame] | 28 | |
| 29 | /** |
| 30 | * Compiles this object to MatchAction plan. |
| 31 | * <p> |
Ray Milkey | 42ae1b5 | 2014-08-15 16:37:06 -0700 | [diff] [blame] | 32 | * This method is called by FlowManagerModule to create MatchAction operations. |
Toshio Koide | a03915e | 2014-07-01 18:39:52 -0700 | [diff] [blame] | 33 | * |
| 34 | * @return a MatchAction plan of this flow object. |
| 35 | */ |
Ray Milkey | 42ae1b5 | 2014-08-15 16:37:06 -0700 | [diff] [blame] | 36 | public MatchActionOperations compile(); |
Toshio Koide | a03915e | 2014-07-01 18:39:52 -0700 | [diff] [blame] | 37 | } |