blob: 2e7a1b91d0845d0b03f0437226f3d00b1e2fefe8 (
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
/*
* Copyright 2014-2015 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 com.google.common.annotations.Beta;
import org.onosproject.core.ApplicationId;
import org.onosproject.net.flow.TrafficSelector;
import java.util.List;
/**
* Service for intercepting data plane packets and for emitting synthetic
* outbound packets.
*/
public interface PacketService {
// TODO: ponder better ordering scheme that does not require absolute numbers
/**
* Adds the specified processor to the list of packet processors.
* It will be added into the list in the order of priority. The higher
* numbers will be processing the packets after the lower numbers.
*
* @param processor processor to be added
* @param priority priority in the reverse natural order
* @throws java.lang.IllegalArgumentException if a processor with the
* given priority already exists
*/
void addProcessor(PacketProcessor processor, int priority);
// TODO allow processors to register for particular types of packets
/**
* Removes the specified processor from the processing pipeline.
*
* @param processor packet processor
*/
void removeProcessor(PacketProcessor processor);
/**
* Returns priority bindings of all registered packet processor entries.
*
* @return list of existing packet processor entries
*/
@Beta
List<PacketProcessorEntry> getProcessors();
/**
* Requests that packets matching the given selector are punted from the
* dataplane to the controller.
*
* @param selector the traffic selector used to match packets
* @param priority the priority of the rule
* @param appId the application ID of the requester
*/
void requestPackets(TrafficSelector selector, PacketPriority priority,
ApplicationId appId);
/**
* Cancels previous packet requests for packets matching the given
* selector to be punted from the dataplane to the controller.
*
* @param selector the traffic selector used to match packets
* @param priority the priority of the rule
* @param appId the application ID of the requester
*/
void cancelPackets(TrafficSelector selector, PacketPriority priority,
ApplicationId appId);
/**
* Returns list of all existing requests ordered by priority.
*
* @return list of existing packet requests
*/
List<PacketRequest> getRequests();
/**
* Emits the specified outbound packet onto the network.
*
* @param packet outbound packet
*/
void emit(OutboundPacket packet);
}
|
