Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 1 | /* |
Ray Milkey | 34c9590 | 2015-04-15 09:47:53 -0700 | [diff] [blame] | 2 | * Copyright 2014-2015 Open Networking Laboratory |
Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
5 | * you may not use this file except in compliance with the License. | ||||
6 | * You may obtain a copy of the License at | ||||
Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
9 | * | ||||
10 | * Unless required by applicable law or agreed to in writing, software | ||||
11 | * distributed under the License is distributed on an "AS IS" BASIS, | ||||
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||
13 | * See the License for the specific language governing permissions and | ||||
14 | * limitations under the License. | ||||
Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.flow; |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 17 | |
alshabib | 7b808c5 | 2015-06-26 14:22:24 -0700 | [diff] [blame] | 18 | import org.onlab.packet.EthType; |
Pavlin Radoslavov | 855ea2d | 2014-10-30 15:32:39 -0700 | [diff] [blame] | 19 | import org.onlab.packet.IpAddress; |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 20 | import org.onlab.packet.MacAddress; |
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 21 | import org.onlab.packet.MplsLabel; |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 22 | import org.onlab.packet.VlanId; |
Jonathan Hart | 54b406b | 2015-03-06 16:24:14 -0800 | [diff] [blame] | 23 | import org.onosproject.core.GroupId; |
24 | import org.onosproject.net.PortNumber; | ||||
25 | import org.onosproject.net.flow.instructions.Instruction; | ||||
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 26 | import org.onosproject.net.flow.instructions.Instructions; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 27 | import org.onosproject.net.meter.MeterId; |
alshabib | 55a55d9 | 2014-09-16 11:59:31 -0700 | [diff] [blame] | 28 | |
Jonathan Hart | 54b406b | 2015-03-06 16:24:14 -0800 | [diff] [blame] | 29 | import java.util.List; |
30 | |||||
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 31 | /** |
32 | * Abstraction of network traffic treatment. | ||||
33 | */ | ||||
34 | public interface TrafficTreatment { | ||||
35 | |||||
36 | /** | ||||
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 37 | * Returns the list of treatment instructions that will be applied |
38 | * further down the pipeline. | ||||
39 | * @return list of treatment instructions | ||||
40 | */ | ||||
41 | List<Instruction> deferred(); | ||||
42 | |||||
43 | /** | ||||
44 | * Returns the list of treatment instructions that will be applied | ||||
45 | * immediately. | ||||
46 | * @return list of treatment instructions | ||||
47 | */ | ||||
48 | List<Instruction> immediate(); | ||||
49 | |||||
50 | /** | ||||
Jonathan Hart | 8ef6d3b | 2015-03-08 21:21:27 -0700 | [diff] [blame] | 51 | * Returns the list of all instructions in the treatment, both immediate and |
52 | * deferred. | ||||
53 | * | ||||
54 | * @return list of treatment instructions | ||||
55 | */ | ||||
56 | List<Instruction> allInstructions(); | ||||
57 | |||||
58 | /** | ||||
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 59 | * Returns the next table in the pipeline. |
60 | * @return a table transition; may be null. | ||||
61 | */ | ||||
62 | Instructions.TableTypeTransition tableTransition(); | ||||
63 | |||||
64 | /** | ||||
65 | * Whether the deferred treatment instructions will be cleared | ||||
66 | * by the device. | ||||
67 | * @return a boolean | ||||
68 | */ | ||||
Jonathan Hart | 4a0ba56 | 2015-03-23 17:23:33 -0700 | [diff] [blame] | 69 | boolean clearedDeferred(); |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 70 | |
71 | /** | ||||
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 72 | * Returns the metadata instruction if there is one. |
73 | * | ||||
74 | * @return a metadata instruction that may be null | ||||
75 | */ | ||||
76 | Instructions.MetadataInstruction writeMetadata(); | ||||
77 | |||||
78 | /** | ||||
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 79 | * Returns the meter instruction if there is one. |
80 | * | ||||
81 | * @return a meter instruction that may be null | ||||
82 | */ | ||||
83 | Instructions.MeterInstruction metered(); | ||||
84 | |||||
85 | /** | ||||
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 86 | * Builder of traffic treatment entities. |
87 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 88 | interface Builder { |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 89 | |
90 | /** | ||||
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 91 | * Adds an instruction to the builder. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 92 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 93 | * @param instruction an instruction |
94 | * @return a treatment builder | ||||
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 95 | */ |
alshabib | 369d294 | 2014-09-12 17:59:35 -0700 | [diff] [blame] | 96 | Builder add(Instruction instruction); |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 97 | |
98 | /** | ||||
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 99 | * Adds a drop instruction. |
100 | * | ||||
101 | * @return a treatment builder | ||||
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 102 | */ |
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 103 | Builder drop(); |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 104 | |
105 | /** | ||||
106 | * Adds a punt-to-controller instruction. | ||||
107 | * | ||||
108 | * @return a treatment builder | ||||
109 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 110 | Builder punt(); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 111 | |
112 | /** | ||||
113 | * Set the output port. | ||||
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 114 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 115 | * @param number the out port |
116 | * @return a treatment builder | ||||
117 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 118 | Builder setOutput(PortNumber number); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 119 | |
120 | /** | ||||
121 | * Sets the src l2 address. | ||||
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 122 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 123 | * @param addr a macaddress |
124 | * @return a treatment builder | ||||
125 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 126 | Builder setEthSrc(MacAddress addr); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 127 | |
128 | /** | ||||
129 | * Sets the dst l2 address. | ||||
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 130 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 131 | * @param addr a macaddress |
132 | * @return a treatment builder | ||||
133 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 134 | Builder setEthDst(MacAddress addr); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 135 | |
136 | /** | ||||
137 | * Sets the vlan id. | ||||
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 138 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 139 | * @param id a vlanid |
140 | * @return a treatment builder | ||||
141 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 142 | Builder setVlanId(VlanId id); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 143 | |
144 | /** | ||||
145 | * Sets the vlan priority. | ||||
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 146 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 147 | * @param pcp a vlan priority |
148 | * @return a treatment builder | ||||
149 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 150 | Builder setVlanPcp(Byte pcp); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 151 | |
152 | /** | ||||
153 | * Sets the src l3 address. | ||||
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 154 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 155 | * @param addr an ip |
156 | * @return a treatment builder | ||||
157 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 158 | Builder setIpSrc(IpAddress addr); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 159 | |
160 | /** | ||||
161 | * Sets the dst l3 address. | ||||
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 162 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 163 | * @param addr an ip |
164 | * @return a treatment builder | ||||
165 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 166 | Builder setIpDst(IpAddress addr); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 167 | |
168 | /** | ||||
Pavlin Radoslavov | febe82c | 2015-02-11 19:08:15 -0800 | [diff] [blame] | 169 | * Decrement the TTL in IP header by one. |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 170 | * |
171 | * @return a treatment builder | ||||
172 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 173 | Builder decNwTtl(); |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 174 | |
175 | /** | ||||
176 | * Copy the TTL to outer protocol layer. | ||||
177 | * | ||||
178 | * @return a treatment builder | ||||
179 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 180 | Builder copyTtlOut(); |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 181 | |
182 | /** | ||||
183 | * Copy the TTL to inner protocol layer. | ||||
184 | * | ||||
185 | * @return a treatment builder | ||||
186 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 187 | Builder copyTtlIn(); |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 188 | |
189 | /** | ||||
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 190 | * Push MPLS ether type. |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 191 | * |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 192 | * @return a treatment builder. |
193 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 194 | Builder pushMpls(); |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 195 | |
196 | /** | ||||
197 | * Pops MPLS ether type. | ||||
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 198 | * |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 199 | * @return a treatment builder. |
200 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 201 | Builder popMpls(); |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 202 | |
203 | /** | ||||
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 204 | * Pops MPLS ether type and set the new ethertype. |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 205 | * |
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 206 | * @param etherType an ether type |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 207 | * @return a treatment builder. |
Sho SHIMIZU | 9a2b081 | 2015-06-30 10:02:22 -0700 | [diff] [blame] | 208 | * @deprecated in Drake Release |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 209 | */ |
alshabib | 7b808c5 | 2015-06-26 14:22:24 -0700 | [diff] [blame] | 210 | @Deprecated |
alshabib | 0ad4398 | 2015-05-07 13:43:13 -0700 | [diff] [blame] | 211 | Builder popMpls(int etherType); |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 212 | |
213 | /** | ||||
alshabib | 7b808c5 | 2015-06-26 14:22:24 -0700 | [diff] [blame] | 214 | * Pops MPLS ether type and set the new ethertype. |
215 | * | ||||
216 | * @param etherType an ether type | ||||
217 | * @return a treatment builder. | ||||
218 | */ | ||||
219 | Builder popMpls(EthType etherType); | ||||
220 | |||||
221 | /** | ||||
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 222 | * Sets the mpls label. |
Thomas Vachuska | f4df005 | 2015-01-06 12:30:11 -0800 | [diff] [blame] | 223 | * |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 224 | * @param mplsLabel MPLS label. |
225 | * @return a treatment builder. | ||||
226 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 227 | Builder setMpls(MplsLabel mplsLabel); |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 228 | |
229 | /** | ||||
Saurav Das | 73a7dd4 | 2015-08-19 22:20:31 -0700 | [diff] [blame] | 230 | * Sets the mpls bottom-of-stack indicator bit. |
231 | * | ||||
232 | * @param mplsBos boolean to set BOS=1 (true) or BOS=0 (false). | ||||
233 | * @return a treatment builder. | ||||
234 | */ | ||||
235 | Builder setMplsBos(boolean mplsBos); | ||||
236 | |||||
237 | /** | ||||
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 238 | * Decrement MPLS TTL. |
239 | * | ||||
240 | * @return a treatment builder | ||||
241 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 242 | Builder decMplsTtl(); |
sangho | 3f97a17d | 2015-01-29 22:56:29 -0800 | [diff] [blame] | 243 | |
244 | /** | ||||
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 245 | * Sets the optical channel ID or lambda. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 246 | * |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 247 | * @param lambda optical channel ID |
248 | * @return a treatment builder | ||||
Sho SHIMIZU | 9553bb8 | 2015-06-30 16:02:45 -0700 | [diff] [blame] | 249 | * @deprecated in Drake Release |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 250 | */ |
Sho SHIMIZU | 9553bb8 | 2015-06-30 16:02:45 -0700 | [diff] [blame] | 251 | @Deprecated |
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 252 | Builder setLambda(short lambda); |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 253 | |
254 | /** | ||||
sangho | 8995ac5 | 2015-02-04 11:29:03 -0800 | [diff] [blame] | 255 | * Sets the group ID. |
256 | * | ||||
257 | * @param groupId group ID | ||||
258 | * @return a treatment builder | ||||
259 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 260 | Builder group(GroupId groupId); |
sangho | 8995ac5 | 2015-02-04 11:29:03 -0800 | [diff] [blame] | 261 | |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 262 | /** |
263 | * Sets a meter to be used by this flow. | ||||
264 | * | ||||
265 | * @param meterId a meter id | ||||
266 | * @return a treatment builder | ||||
267 | */ | ||||
268 | Builder meter(MeterId meterId); | ||||
alshabib | 9af7007 | 2015-02-09 14:34:16 -0800 | [diff] [blame] | 269 | |
270 | /** | ||||
271 | * Sets the next table type to transition to. | ||||
272 | * | ||||
273 | * @param type the table type | ||||
274 | * @return a treatement builder | ||||
Sho SHIMIZU | 9a2b081 | 2015-06-30 10:02:22 -0700 | [diff] [blame] | 275 | * @deprecated in Cardinal Release |
alshabib | 9af7007 | 2015-02-09 14:34:16 -0800 | [diff] [blame] | 276 | */ |
alshabib | d17abc2 | 2015-04-21 18:26:35 -0700 | [diff] [blame] | 277 | @Deprecated |
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 278 | Builder transition(FlowRule.Type type); |
alshabib | 9af7007 | 2015-02-09 14:34:16 -0800 | [diff] [blame] | 279 | |
sangho | 8995ac5 | 2015-02-04 11:29:03 -0800 | [diff] [blame] | 280 | /** |
alshabib | d17abc2 | 2015-04-21 18:26:35 -0700 | [diff] [blame] | 281 | * Sets the next table id to transition to. |
282 | * | ||||
283 | * @param tableId the table table | ||||
284 | * @return a treatement builder | ||||
285 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 286 | Builder transition(Integer tableId); |
alshabib | d17abc2 | 2015-04-21 18:26:35 -0700 | [diff] [blame] | 287 | |
288 | |||||
289 | /** | ||||
Saurav Das | fbe25c5 | 2015-03-04 11:12:00 -0800 | [diff] [blame] | 290 | * Pops outermost VLAN tag. |
291 | * | ||||
292 | * @return a treatment builder. | ||||
293 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 294 | Builder popVlan(); |
Saurav Das | fbe25c5 | 2015-03-04 11:12:00 -0800 | [diff] [blame] | 295 | |
296 | /** | ||||
Jonathan Hart | 54b406b | 2015-03-06 16:24:14 -0800 | [diff] [blame] | 297 | * Pushes a new VLAN tag. |
298 | * | ||||
299 | * @return a treatment builder. | ||||
300 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 301 | Builder pushVlan(); |
Jonathan Hart | 54b406b | 2015-03-06 16:24:14 -0800 | [diff] [blame] | 302 | |
303 | /** | ||||
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 304 | * Any instructions preceded by this method call will be deferred. |
305 | * @return a treatment builder | ||||
306 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 307 | Builder deferred(); |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 308 | |
309 | /** | ||||
310 | * Any instructions preceded by this method call will be immediate. | ||||
311 | * @return a treatment builder | ||||
312 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 313 | Builder immediate(); |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 314 | |
315 | |||||
316 | /** | ||||
317 | * Instructs the device to clear the deferred instructions set. | ||||
318 | * @return a treatment builder | ||||
319 | */ | ||||
Sho SHIMIZU | 79906e4 | 2015-05-04 18:27:31 -0700 | [diff] [blame] | 320 | Builder wipeDeferred(); |
alshabib | 346b5b3 | 2015-03-06 00:42:16 -0800 | [diff] [blame] | 321 | |
322 | /** | ||||
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 323 | * Writes metadata to associate with a packet. |
324 | * <pre> | ||||
325 | * {@code | ||||
326 | * new_metadata = (old_metadata & ̃mask) | (value & mask) | ||||
327 | * } | ||||
328 | * </pre> | ||||
329 | * | ||||
330 | * @param value the metadata to write | ||||
331 | * @param mask the masked bits for the value | ||||
332 | * @return a treatment builder | ||||
333 | */ | ||||
334 | Builder writeMetadata(long value, long mask); | ||||
335 | |||||
336 | /** | ||||
Hyunsun Moon | a08c5d0 | 2015-07-14 17:53:00 -0700 | [diff] [blame] | 337 | * Sets the tunnel id. |
338 | * | ||||
339 | * @param tunnelId a tunnel id. | ||||
340 | * @return a treatment builder. | ||||
341 | */ | ||||
342 | Builder setTunnelId(long tunnelId); | ||||
343 | |||||
344 | /** | ||||
Hyunsun Moon | c8bd97c | 2015-07-18 22:47:33 -0700 | [diff] [blame] | 345 | * Sets the src TCP port. |
346 | * | ||||
347 | * @param port a port number | ||||
348 | * @return a treatment builder | ||||
349 | */ | ||||
350 | Builder setTcpSrc(short port); | ||||
351 | |||||
352 | /** | ||||
353 | * Sets the dst TCP port. | ||||
354 | * | ||||
355 | * @param port a port number | ||||
356 | * @return a treatment builder | ||||
357 | */ | ||||
358 | Builder setTcpDst(short port); | ||||
359 | |||||
360 | /** | ||||
361 | * Sets the src UDP port. | ||||
362 | * | ||||
363 | * @param port a port number | ||||
364 | * @return a treatment builder | ||||
365 | */ | ||||
366 | Builder setUdpSrc(short port); | ||||
367 | |||||
368 | /** | ||||
369 | * Sets the dst UDP port. | ||||
370 | * | ||||
371 | * @param port a port number | ||||
372 | * @return a treatment builder | ||||
373 | */ | ||||
374 | Builder setUdpDst(short port); | ||||
375 | |||||
376 | /** | ||||
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 377 | * Builds an immutable traffic treatment descriptor. |
Brian O'Connor | 6b52813 | 2015-03-10 16:39:52 -0700 | [diff] [blame] | 378 | * <p> |
379 | * If the treatment is empty when build() is called, it will add a default | ||||
380 | * drop rule automatically. For a treatment that is actually empty, use | ||||
381 | * {@link org.onosproject.net.flow.DefaultTrafficTreatment#emptyTreatment}. | ||||
382 | * </p> | ||||
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 383 | * |
384 | * @return traffic treatment | ||||
385 | */ | ||||
386 | TrafficTreatment build(); | ||||
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 387 | |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 388 | } |
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 389 | |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 390 | } |