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 | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 27 | * Behavior to program the pipeline of a device that supports |
| 28 | * protocol-independence. |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 29 | */ |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 30 | @Beta |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 31 | public interface PiPipelineProgrammable extends HandlerBehaviour { |
| 32 | /** |
Carmelo Cascone | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 33 | * Writes the given pipeconf to the device, returns a completable future |
| 34 | * with true is the operations was successful, false otherwise. |
| 35 | * <p> |
| 36 | * After the future has been completed, the device is expected to process |
| 37 | * data plane packets according to the written pipeconf. |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 38 | * |
| 39 | * @param pipeconf pipeconf |
Carmelo Cascone | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 40 | * @return completable future set to true if the operation was successful, |
| 41 | * false otherwise |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 42 | */ |
| 43 | // TODO: return an explanation of why things went wrong, and the status of the device. |
Carmelo Cascone | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 44 | CompletableFuture<Boolean> setPipeconf(PiPipeconf pipeconf); |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 45 | |
| 46 | /** |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 47 | * Probes the device to verify that the given pipeconf is the one currently |
| 48 | * configured. |
Carmelo Cascone | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 49 | * <p> |
| 50 | * This method is expected to always return true after successfully calling |
| 51 | * {@link #setPipeconf(PiPipeconf)} with the given pipeconf. |
| 52 | * |
| 53 | * @param pipeconf pipeconf |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 54 | * @return completable future eventually true if the device has the given |
| 55 | * pipeconf set, false otherwise |
Carmelo Cascone | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 56 | */ |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 57 | CompletableFuture<Boolean> isPipeconfSet(PiPipeconf pipeconf); |
Carmelo Cascone | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 58 | |
| 59 | /** |
| 60 | * Returns the default pipeconf for this device, to be used when any other |
| 61 | * pipeconf is not available. |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 62 | * |
| 63 | * @return optional pipeconf |
| 64 | */ |
| 65 | Optional<PiPipeconf> getDefaultPipeconf(); |
| 66 | } |