Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Foundation |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 3 | * |
| 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 |
| 7 | * |
| 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. |
| 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.packet; |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 17 | |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 18 | import org.onosproject.net.DeviceId; |
Thiago Santos | a4a17cb | 2019-01-30 14:23:58 -0800 | [diff] [blame] | 19 | import org.onosproject.net.PortNumber; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 20 | import org.onosproject.net.flow.TrafficTreatment; |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 21 | |
| 22 | import java.nio.ByteBuffer; |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 23 | |
| 24 | /** |
| 25 | * Represents an outbound data packet that is to be emitted to network via |
| 26 | * an infrastructure device. |
| 27 | */ |
| 28 | public interface OutboundPacket { |
| 29 | |
| 30 | /** |
| 31 | * Returns the identity of a device through which this packet should be |
| 32 | * sent. |
| 33 | * |
| 34 | * @return device identity |
| 35 | */ |
| 36 | DeviceId sendThrough(); |
| 37 | |
| 38 | /** |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 39 | * Returns how the outbound packet should be treated. |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 40 | * |
| 41 | * @return output treatment |
| 42 | */ |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 43 | TrafficTreatment treatment(); |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 44 | |
| 45 | /** |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 46 | * Returns immutable view of the raw data to be sent. |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 47 | * |
| 48 | * @return data to emit |
| 49 | */ |
| 50 | ByteBuffer data(); |
| 51 | |
Thiago Santos | a4a17cb | 2019-01-30 14:23:58 -0800 | [diff] [blame] | 52 | /** |
| 53 | * Returns the input port of this packet. |
| 54 | * |
| 55 | * Defaults to controller port. This is useful for actions that involve the input port |
| 56 | * such as ALL or FLOOD. |
| 57 | * |
| 58 | * @return the input port to be used for this packet. |
| 59 | */ |
| 60 | default PortNumber inPort() { |
| 61 | return PortNumber.CONTROLLER; |
| 62 | } |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 63 | } |