Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2014 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 | */ |
tom | b36046e | 2014-08-27 00:22:24 -0700 | [diff] [blame] | 16 | package org.onlab.onos.net; |
| 17 | |
Jonathan Hart | b79d641 | 2014-09-19 11:24:06 -0700 | [diff] [blame] | 18 | |
tom | b36046e | 2014-08-27 00:22:24 -0700 | [diff] [blame] | 19 | /** |
| 20 | * Abstraction of a network port. |
| 21 | */ |
tom | 3ea1125 | 2014-10-02 04:32:26 -0700 | [diff] [blame] | 22 | public interface Port extends Annotated { |
tom | b36046e | 2014-08-27 00:22:24 -0700 | [diff] [blame] | 23 | |
tom | ca20e0c | 2014-09-03 23:22:24 -0700 | [diff] [blame] | 24 | /** |
tom | b36046e | 2014-08-27 00:22:24 -0700 | [diff] [blame] | 25 | * Returns the port number. |
| 26 | * |
| 27 | * @return port number |
| 28 | */ |
| 29 | PortNumber number(); |
| 30 | |
| 31 | /** |
tom | ca20e0c | 2014-09-03 23:22:24 -0700 | [diff] [blame] | 32 | * Indicates whether or not the port is currently up and active. |
| 33 | * |
| 34 | * @return true if the port is operational |
| 35 | */ |
| 36 | boolean isEnabled(); |
| 37 | |
| 38 | /** |
tom | 29df6f4 | 2014-09-05 08:14:14 -0700 | [diff] [blame] | 39 | * Returns the parent network element to which this port belongs. |
tom | b36046e | 2014-08-27 00:22:24 -0700 | [diff] [blame] | 40 | * |
| 41 | * @return parent network element |
| 42 | */ |
tom | 29df6f4 | 2014-09-05 08:14:14 -0700 | [diff] [blame] | 43 | Element element(); |
tom | b36046e | 2014-08-27 00:22:24 -0700 | [diff] [blame] | 44 | |
| 45 | // set of port attributes |
| 46 | |
tom | b36046e | 2014-08-27 00:22:24 -0700 | [diff] [blame] | 47 | } |