Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 1 | /* |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 2 | * Copyright 2014 Open Networking Laboratory |
Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -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 | 781d18b | 2014-10-27 10:31:25 -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 | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.openflow.controller; |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 17 | |
| 18 | import org.onlab.packet.Ethernet; |
| 19 | import org.projectfloodlight.openflow.types.OFPort; |
| 20 | |
| 21 | /** |
| 22 | * A representation of a packet context which allows any provider |
Ayaka Koshibe | ab3374b | 2014-09-19 11:41:25 -0700 | [diff] [blame] | 23 | * to view a packet in event, but may block the response to the |
| 24 | * event if blocked has been called. This packet context can be used |
| 25 | * to react to the packet in event with a packet out. |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 26 | */ |
| 27 | public interface OpenFlowPacketContext { |
| 28 | |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 29 | /** |
| 30 | * Blocks further responses (ie. send() calls) on this |
| 31 | * packet in event. |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 32 | * @return true if blocks |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 33 | */ |
Sho SHIMIZU | 358815c | 2015-05-13 11:25:32 -0700 | [diff] [blame] | 34 | boolean block(); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 35 | |
| 36 | /** |
| 37 | * Checks whether the packet has been handled. |
| 38 | * @return true if handled, false otherwise. |
| 39 | */ |
Sho SHIMIZU | 358815c | 2015-05-13 11:25:32 -0700 | [diff] [blame] | 40 | boolean isHandled(); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 41 | |
| 42 | /** |
| 43 | * Provided build has been called send the packet |
| 44 | * out the switch it came in on. |
| 45 | */ |
Sho SHIMIZU | 358815c | 2015-05-13 11:25:32 -0700 | [diff] [blame] | 46 | void send(); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 47 | |
| 48 | /** |
| 49 | * Build the packet out in response to this packet in event. |
| 50 | * @param outPort the out port to send to packet out of. |
| 51 | */ |
Sho SHIMIZU | 358815c | 2015-05-13 11:25:32 -0700 | [diff] [blame] | 52 | void build(OFPort outPort); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 53 | |
| 54 | /** |
| 55 | * Build the packet out in response to this packet in event. |
| 56 | * @param ethFrame the actual packet to send out. |
| 57 | * @param outPort the out port to send to packet out of. |
| 58 | */ |
Sho SHIMIZU | 358815c | 2015-05-13 11:25:32 -0700 | [diff] [blame] | 59 | void build(Ethernet ethFrame, OFPort outPort); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 60 | |
| 61 | /** |
| 62 | * Provided a handle onto the parsed payload. |
| 63 | * @return the parsed form of the payload. |
| 64 | */ |
Sho SHIMIZU | 358815c | 2015-05-13 11:25:32 -0700 | [diff] [blame] | 65 | Ethernet parsed(); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 66 | |
| 67 | /** |
| 68 | * Provide an unparsed copy of the data. |
| 69 | * @return the unparsed form of the payload. |
| 70 | */ |
Sho SHIMIZU | 358815c | 2015-05-13 11:25:32 -0700 | [diff] [blame] | 71 | byte[] unparsed(); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 72 | |
| 73 | /** |
| 74 | * Provide the dpid of the switch where the packet in arrived. |
| 75 | * @return the dpid of the switch. |
| 76 | */ |
Sho SHIMIZU | 358815c | 2015-05-13 11:25:32 -0700 | [diff] [blame] | 77 | Dpid dpid(); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 78 | |
| 79 | /** |
| 80 | * Provide the port on which the packet arrived. |
| 81 | * @return the port |
| 82 | */ |
Sho SHIMIZU | 358815c | 2015-05-13 11:25:32 -0700 | [diff] [blame] | 83 | Integer inPort(); |
alshabib | e9d3a32 | 2014-09-23 15:18:33 -0700 | [diff] [blame] | 84 | |
| 85 | /** |
| 86 | * Indicates that this packet is buffered at the switch. |
| 87 | * @return buffer indication |
| 88 | */ |
| 89 | boolean isBuffered(); |
tom | 7ef8ff9 | 2014-09-17 13:08:06 -0700 | [diff] [blame] | 90 | } |