blob: 004adc872b1a03740d45bc4ba440edc898a3803e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
/*
* Copyright 2014 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.net.packet;
import org.onosproject.net.flow.TrafficTreatment;
/**
* Represents context for processing an inbound packet, and (optionally)
* emitting a corresponding outbound packet.
*/
public interface PacketContext {
/**
* Returns the time when the packet was received.
*
* @return the time in millis since start of epoch
*/
long time();
/**
* Returns the inbound packet being processed.
*
* @return inbound packet
*/
InboundPacket inPacket();
/**
* Returns the view of the outbound packet.
*
* @return outbound packet
*/
OutboundPacket outPacket();
/**
* Returns a builder for constructing traffic treatment.
*
* @return traffic treatment builder
*/
TrafficTreatment.Builder treatmentBuilder();
/**
* Triggers the outbound packet to be sent.
*/
void send();
/**
* Blocks the outbound packet from being sent from this point onward.
*
* @return whether the outbound packet is blocked.
*/
boolean block();
/**
* Indicates whether the outbound packet is handled, i.e. sent or blocked.
*
* @return true uf the packed is handled
*/
boolean isHandled();
}
|
