Carmelo Cascone | 1a7e4f9 | 2017-11-20 23:04:02 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2017-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.pi.runtime; |
| 18 | |
| 19 | import com.google.common.annotations.Beta; |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 20 | import org.onosproject.net.DeviceId; |
Carmelo Cascone | 1a7e4f9 | 2017-11-20 23:04:02 -0800 | [diff] [blame] | 21 | |
| 22 | /** |
Carmelo Cascone | a7e60c6 | 2019-03-21 17:58:12 -0700 | [diff] [blame] | 23 | * Abstraction of a runtime entity of a protocol-independent pipeline. |
Carmelo Cascone | 1a7e4f9 | 2017-11-20 23:04:02 -0800 | [diff] [blame] | 24 | */ |
| 25 | @Beta |
| 26 | public interface PiEntity { |
| 27 | |
| 28 | /** |
| 29 | * Returns the type of this entity. |
| 30 | * |
| 31 | * @return entity type |
| 32 | */ |
| 33 | PiEntityType piEntityType(); |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 34 | |
| 35 | /** |
| 36 | * Returns a handle for this PI entity and the given device ID. |
| 37 | * |
| 38 | * @param deviceId device ID |
| 39 | * @return handle |
| 40 | */ |
| 41 | PiHandle handle(DeviceId deviceId); |
Carmelo Cascone | 1a7e4f9 | 2017-11-20 23:04:02 -0800 | [diff] [blame] | 42 | } |