Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Laboratory |
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 | |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 18 | import com.google.common.annotations.Beta; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 19 | import org.onosproject.core.ApplicationId; |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 20 | import org.onosproject.net.DeviceId; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 21 | import org.onosproject.net.flow.TrafficSelector; |
| 22 | |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 23 | import java.util.List; |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 24 | import java.util.Optional; |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 25 | |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 26 | /** |
| 27 | * Service for intercepting data plane packets and for emitting synthetic |
| 28 | * outbound packets. |
| 29 | */ |
| 30 | public interface PacketService { |
| 31 | |
| 32 | // TODO: ponder better ordering scheme that does not require absolute numbers |
| 33 | |
| 34 | /** |
| 35 | * Adds the specified processor to the list of packet processors. |
| 36 | * It will be added into the list in the order of priority. The higher |
| 37 | * numbers will be processing the packets after the lower numbers. |
| 38 | * |
| 39 | * @param processor processor to be added |
| 40 | * @param priority priority in the reverse natural order |
| 41 | * @throws java.lang.IllegalArgumentException if a processor with the |
| 42 | * given priority already exists |
| 43 | */ |
alshabib | 369d294 | 2014-09-12 17:59:35 -0700 | [diff] [blame] | 44 | void addProcessor(PacketProcessor processor, int priority); |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 45 | |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 46 | // TODO allow processors to register for particular types of packets |
| 47 | |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 48 | /** |
| 49 | * Removes the specified processor from the processing pipeline. |
| 50 | * |
| 51 | * @param processor packet processor |
| 52 | */ |
| 53 | void removeProcessor(PacketProcessor processor); |
| 54 | |
| 55 | /** |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 56 | * Returns priority bindings of all registered packet processor entries. |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 57 | * |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 58 | * @return list of existing packet processor entries |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 59 | */ |
| 60 | @Beta |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 61 | List<PacketProcessorEntry> getProcessors(); |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 62 | |
| 63 | /** |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 64 | * Requests that packets matching the given selector are punted from the |
| 65 | * dataplane to the controller. |
| 66 | * |
| 67 | * @param selector the traffic selector used to match packets |
| 68 | * @param priority the priority of the rule |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 69 | * @param appId the application ID of the requester |
Ray Milkey | ea12532 | 2016-02-16 13:35:09 -0800 | [diff] [blame] | 70 | * @deprecated 1.5.0 Falcon Release |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 71 | */ |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 72 | @Deprecated |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 73 | void requestPackets(TrafficSelector selector, PacketPriority priority, |
| 74 | ApplicationId appId); |
| 75 | |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 76 | |
| 77 | /** |
| 78 | * Requests that packets matching the given selector are punted from the |
| 79 | * dataplane to the controller. If a deviceId is specified then the |
| 80 | * packet request is only installed at the device represented by that |
| 81 | * deviceId. |
| 82 | * |
| 83 | * @param selector the traffic selector used to match packets |
| 84 | * @param priority the priority of the rule |
| 85 | * @param appId the application ID of the requester |
| 86 | * @param deviceId an optional deviceId |
| 87 | */ |
| 88 | void requestPackets(TrafficSelector selector, PacketPriority priority, |
| 89 | ApplicationId appId, Optional<DeviceId> deviceId); |
| 90 | |
Saurav Das | c313c40 | 2015-02-27 10:09:47 -0800 | [diff] [blame] | 91 | /** |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 92 | * Cancels previous packet requests for packets matching the given |
| 93 | * selector to be punted from the dataplane to the controller. |
Saurav Das | c313c40 | 2015-02-27 10:09:47 -0800 | [diff] [blame] | 94 | * |
| 95 | * @param selector the traffic selector used to match packets |
| 96 | * @param priority the priority of the rule |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 97 | * @param appId the application ID of the requester |
Ray Milkey | ea12532 | 2016-02-16 13:35:09 -0800 | [diff] [blame] | 98 | * @deprecated 1.5.0 Falcon Release |
Saurav Das | c313c40 | 2015-02-27 10:09:47 -0800 | [diff] [blame] | 99 | */ |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 100 | @Deprecated |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 101 | void cancelPackets(TrafficSelector selector, PacketPriority priority, |
| 102 | ApplicationId appId); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 103 | |
| 104 | /** |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 105 | * Cancels previous packet requests for packets matching the given |
| 106 | * selector to be punted from the dataplane to the controller. If a |
| 107 | * deviceId is specified then the packet request is only withdrawn from |
| 108 | * the device represented by that deviceId. |
| 109 | * |
| 110 | * @param selector the traffic selector used to match packets |
| 111 | * @param priority the priority of the rule |
| 112 | * @param appId the application ID of the requester |
| 113 | * @param deviceId an optional deviceId |
| 114 | */ |
| 115 | void cancelPackets(TrafficSelector selector, PacketPriority priority, |
| 116 | ApplicationId appId, Optional<DeviceId> deviceId); |
| 117 | |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 118 | /** |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 119 | * Returns list of all existing requests ordered by priority. |
| 120 | * |
| 121 | * @return list of existing packet requests |
| 122 | */ |
| 123 | List<PacketRequest> getRequests(); |
| 124 | |
| 125 | /** |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 126 | * Emits the specified outbound packet onto the network. |
| 127 | * |
| 128 | * @param packet outbound packet |
| 129 | */ |
| 130 | void emit(OutboundPacket packet); |
| 131 | |
| 132 | } |