diff options
author | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
---|---|---|
committer | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
commit | 13d05bc8458758ee39cb829098241e89616717ee (patch) | |
tree | 22a4d1ce65f15952f07a3df5af4b462b4697cb3a /framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketService.java | |
parent | 6139282e1e93c2322076de4b91b1c85d0bc4a8b3 (diff) |
ONOS checkin based on commit tag e796610b1f721d02f9b0e213cf6f7790c10ecd60
Change-Id: Ife8810491034fe7becdba75dda20de4267bd15cd
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketService.java')
-rw-r--r-- | framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketService.java | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketService.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketService.java new file mode 100644 index 00000000..06c416ec --- /dev/null +++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/packet/PacketService.java @@ -0,0 +1,79 @@ +/* + * 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 org.onosproject.core.ApplicationId; +import org.onosproject.net.flow.TrafficSelector; + +/** + * 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); + + /** + * 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); + + /** + * Emits the specified outbound packet onto the network. + * + * @param packet outbound packet + */ + void emit(OutboundPacket packet); + +} |