alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 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 | */ |
| 16 | package org.onosproject.net.behaviour; |
| 17 | |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 18 | import org.onosproject.net.DeviceId; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 19 | import org.onosproject.net.driver.HandlerBehaviour; |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 20 | import org.onosproject.net.flowobjective.FilteringObjective; |
| 21 | import org.onosproject.net.flowobjective.ForwardingObjective; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 22 | import org.onosproject.net.flowobjective.NextObjective; |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 23 | |
| 24 | import java.util.Collection; |
| 25 | import java.util.concurrent.Future; |
| 26 | |
| 27 | /** |
| 28 | * Behaviour for handling various pipelines. |
| 29 | */ |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 30 | public interface Pipeliner extends HandlerBehaviour { |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 31 | |
| 32 | /** |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame^] | 33 | * Initializes the driver with context required for its operation. |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 34 | * |
| 35 | * @param deviceId the deviceId |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame^] | 36 | * @param context processing context |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 37 | */ |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame^] | 38 | void init(DeviceId deviceId, PipelinerContext context); |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 39 | |
| 40 | /** |
| 41 | * Installs the filtering rules onto the device. |
| 42 | * |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame^] | 43 | * @param filterObjectives the collection of filters |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 44 | * @return a future indicating the success of the operation |
| 45 | */ |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame^] | 46 | Future<Boolean> filter(Collection<FilteringObjective> filterObjectives); |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 47 | |
| 48 | /** |
| 49 | * Installs the forwarding rules onto the device. |
| 50 | * |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 51 | * @param forwardObjectives the collection of forwarding objectives |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 52 | * @return a future indicating the success of the operation |
| 53 | */ |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 54 | Future<Boolean> forward(Collection<ForwardingObjective> forwardObjectives); |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 55 | |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 56 | /** |
| 57 | * Installs the next hop elements into the device. |
| 58 | * |
| 59 | * @param nextObjectives the collection of next objectives |
| 60 | * @return a future indicating the success of the operation |
| 61 | */ |
| 62 | Future<Boolean> next(Collection<NextObjective> nextObjectives); |
alshabib | faa1e36 | 2015-04-02 15:01:54 -0700 | [diff] [blame] | 63 | } |