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.flow.TrafficTreatment; |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 19 | |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 20 | /** |
| 21 | * Represents context for processing an inbound packet, and (optionally) |
| 22 | * emitting a corresponding outbound packet. |
| 23 | */ |
| 24 | public interface PacketContext { |
| 25 | |
| 26 | /** |
| 27 | * Returns the time when the packet was received. |
| 28 | * |
| 29 | * @return the time in millis since start of epoch |
| 30 | */ |
| 31 | long time(); |
| 32 | |
| 33 | /** |
| 34 | * Returns the inbound packet being processed. |
| 35 | * |
| 36 | * @return inbound packet |
| 37 | */ |
| 38 | InboundPacket inPacket(); |
| 39 | |
| 40 | /** |
| 41 | * Returns the view of the outbound packet. |
| 42 | * |
| 43 | * @return outbound packet |
| 44 | */ |
| 45 | OutboundPacket outPacket(); |
| 46 | |
| 47 | /** |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 48 | * Returns a builder for constructing traffic treatment. |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 49 | * |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 50 | * @return traffic treatment builder |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 51 | */ |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 52 | TrafficTreatment.Builder treatmentBuilder(); |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 53 | |
| 54 | /** |
| 55 | * Triggers the outbound packet to be sent. |
| 56 | */ |
| 57 | void send(); |
| 58 | |
| 59 | /** |
| 60 | * Blocks the outbound packet from being sent from this point onward. |
tom | 89b63c5 | 2014-09-16 09:19:51 -0700 | [diff] [blame] | 61 | * |
alshabib | 63d5afe | 2014-09-15 09:40:24 -0700 | [diff] [blame] | 62 | * @return whether the outbound packet is blocked. |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 63 | */ |
alshabib | 030111e | 2014-09-15 15:56:42 -0700 | [diff] [blame] | 64 | boolean block(); |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 65 | |
| 66 | /** |
tom | 89b63c5 | 2014-09-16 09:19:51 -0700 | [diff] [blame] | 67 | * Indicates whether the outbound packet is handled, i.e. sent or blocked. |
| 68 | * |
| 69 | * @return true uf the packed is handled |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 70 | */ |
| 71 | boolean isHandled(); |
| 72 | |
| 73 | } |