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.instructions; |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 17 | |
| 18 | /** |
| 19 | * Abstraction of a single traffic treatment step. |
| 20 | */ |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 21 | public interface Instruction { |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 22 | |
| 23 | /** |
| 24 | * Represents the type of traffic treatment. |
| 25 | */ |
Sho SHIMIZU | d150620 | 2015-05-05 10:43:08 -0700 | [diff] [blame] | 26 | enum Type { |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 27 | /** |
| 28 | * Signifies that the traffic should be dropped. |
Ray Milkey | ea12532 | 2016-02-16 13:35:09 -0800 | [diff] [blame] | 29 | * @deprecated 1.4.0 Emu Release |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 30 | */ |
Charles Chan | 7efabeb | 2015-09-28 15:12:19 -0700 | [diff] [blame] | 31 | @Deprecated |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 32 | DROP, |
| 33 | |
| 34 | /** |
Charles Chan | 7efabeb | 2015-09-28 15:12:19 -0700 | [diff] [blame] | 35 | * Signifies that the traffic requires no action. |
| 36 | * |
| 37 | * In OF10, the behavior of NOACTION is DROP. |
| 38 | * In OF13, the behavior depends on current Action Set. |
| 39 | */ |
| 40 | NOACTION, |
| 41 | |
| 42 | /** |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 43 | * Signifies that the traffic should be output to a port. |
| 44 | */ |
| 45 | OUTPUT, |
| 46 | |
| 47 | /** |
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 48 | * Signifies that traffic should be sent out of a group. |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 49 | */ |
| 50 | GROUP, |
| 51 | |
| 52 | /** |
Steffen Gebert | bbfdaaa | 2015-09-29 11:01:46 +0200 | [diff] [blame] | 53 | * Signifies that the traffic should be enqueued to an already-configured |
| 54 | queue on a port. |
| 55 | */ |
| 56 | QUEUE, |
| 57 | |
| 58 | /** |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 59 | * Signifies that traffic should be metered according to a meter. |
| 60 | */ |
| 61 | METER, |
| 62 | |
| 63 | /** |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 64 | * Signifies that the traffic should be modified in L0 way. |
| 65 | */ |
| 66 | L0MODIFICATION, |
| 67 | |
| 68 | /** |
Yafit Hadar | 52d8155 | 2015-10-07 12:26:52 +0300 | [diff] [blame] | 69 | * Signifies that the traffic should be modified in L1 way. |
| 70 | */ |
| 71 | L1MODIFICATION, |
| 72 | |
| 73 | /** |
alshabib | 35edb1a | 2014-09-16 17:44:44 -0700 | [diff] [blame] | 74 | * Signifies that the traffic should be modified in L2 way. |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 75 | */ |
alshabib | 35edb1a | 2014-09-16 17:44:44 -0700 | [diff] [blame] | 76 | L2MODIFICATION, |
| 77 | |
| 78 | /** |
alshabib | 9af7007 | 2015-02-09 14:34:16 -0800 | [diff] [blame] | 79 | * Signifies that the traffic should be passed to another table. |
| 80 | */ |
| 81 | TABLE, |
| 82 | |
| 83 | /** |
alshabib | 35edb1a | 2014-09-16 17:44:44 -0700 | [diff] [blame] | 84 | * Signifies that the traffic should be modified in L3 way. |
| 85 | */ |
Saurav Das | 86af8f1 | 2015-05-25 23:55:33 -0700 | [diff] [blame] | 86 | L3MODIFICATION, |
| 87 | |
| 88 | /** |
| 89 | * Signifies that metadata be attached to traffic. |
| 90 | */ |
Hyunsun Moon | 9fed528 | 2015-07-16 17:55:22 -0700 | [diff] [blame] | 91 | METADATA, |
| 92 | |
| 93 | /** |
| 94 | * Signifies that the traffic should be modified in L4 way. |
| 95 | */ |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 96 | L4MODIFICATION, |
| 97 | |
| 98 | /** |
| 99 | * Signifies that an extension instruction will be used. |
| 100 | */ |
| 101 | EXTENSION |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 102 | } |
| 103 | |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 104 | /** |
alshabib | 89e43ef | 2014-09-16 10:36:34 -0700 | [diff] [blame] | 105 | * Returns the type of instruction. |
Yafit Hadar | 52d8155 | 2015-10-07 12:26:52 +0300 | [diff] [blame] | 106 | * |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 107 | * @return type of instruction |
| 108 | */ |
Sho SHIMIZU | d150620 | 2015-05-05 10:43:08 -0700 | [diff] [blame] | 109 | Type type(); |
alshabib | 1d4cace | 2014-09-13 19:16:26 -0700 | [diff] [blame] | 110 | |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 111 | } |