pierventre | b58e9c9 | 2020-05-22 09:42:31 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2020-present Open Networking Foundation |
| 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 | |
| 17 | package org.onosproject.net.behaviour; |
| 18 | |
| 19 | import org.onosproject.net.PipelineTraceableInput; |
| 20 | import org.onosproject.net.PipelineTraceableOutput; |
| 21 | import org.onosproject.net.driver.HandlerBehaviour; |
| 22 | |
| 23 | /** |
| 24 | * Represents a driver behavior that enables a logical packet to trace existing flows and groups in a device. |
| 25 | */ |
| 26 | public interface PipelineTraceable extends HandlerBehaviour { |
| 27 | |
| 28 | /** |
| 29 | * Initializes the traceable with a context required for its operation. |
| 30 | */ |
| 31 | void init(); |
| 32 | |
| 33 | /** |
| 34 | * Applies pipeline processing on the given ingress state. |
| 35 | * |
| 36 | * @param input the input of the apply process |
| 37 | * @return the output of the apply process |
| 38 | */ |
| 39 | PipelineTraceableOutput apply(PipelineTraceableInput input); |
| 40 | |
| 41 | } |