Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2017-present Open Networking Foundation |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [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 | */ |
| 16 | |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 17 | package org.onosproject.net.behaviour; |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 18 | |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 19 | import com.google.common.annotations.Beta; |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 20 | import org.onosproject.net.driver.HandlerBehaviour; |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 21 | import org.onosproject.net.pi.model.PiPipeconf; |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 22 | |
| 23 | import java.util.Optional; |
| 24 | import java.util.concurrent.CompletableFuture; |
| 25 | |
| 26 | /** |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 27 | * Behavior to program the pipeline of a device that supports protocol-independence. |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 28 | */ |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 29 | @Beta |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 30 | public interface PiPipelineProgrammable extends HandlerBehaviour { |
| 31 | /** |
| 32 | * Deploys the given pipeconf to the device. |
| 33 | * |
| 34 | * @param pipeconf pipeconf |
| 35 | * @return true if the operation was successful, false otherwise |
| 36 | */ |
| 37 | // TODO: return an explanation of why things went wrong, and the status of the device. |
| 38 | CompletableFuture<Boolean> deployPipeconf(PiPipeconf pipeconf); |
| 39 | |
| 40 | /** |
| 41 | * Returns the default pipeconf for ths device, to be used when any other pipeconf is not available. |
| 42 | * |
| 43 | * @return optional pipeconf |
| 44 | */ |
| 45 | Optional<PiPipeconf> getDefaultPipeconf(); |
| 46 | } |