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 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.device; |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 17 | |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 18 | import org.onosproject.net.Description; |
| 19 | import org.onosproject.net.PortNumber; |
tom | ca20e0c | 2014-09-03 23:22:24 -0700 | [diff] [blame] | 20 | |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 21 | import static org.onosproject.net.Port.Type; |
Thomas Vachuska | d16ce18 | 2014-10-29 17:25:29 -0700 | [diff] [blame] | 22 | |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 23 | /** |
| 24 | * Information about a port. |
| 25 | */ |
Yuta HIGUCHI | 55710e7 | 2014-10-02 14:58:32 -0700 | [diff] [blame] | 26 | public interface PortDescription extends Description { |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 27 | |
tom | ca20e0c | 2014-09-03 23:22:24 -0700 | [diff] [blame] | 28 | /** |
| 29 | * Returns the port number. |
| 30 | * |
| 31 | * @return port number |
| 32 | */ |
| 33 | PortNumber portNumber(); |
| 34 | |
| 35 | /** |
tom | d40fc7a | 2014-09-04 16:41:10 -0700 | [diff] [blame] | 36 | * Indicates whether or not the port is up and active. |
tom | ca20e0c | 2014-09-03 23:22:24 -0700 | [diff] [blame] | 37 | * |
tom | d40fc7a | 2014-09-04 16:41:10 -0700 | [diff] [blame] | 38 | * @return true if the port is active and has carrier signal |
tom | ca20e0c | 2014-09-03 23:22:24 -0700 | [diff] [blame] | 39 | */ |
tom | d40fc7a | 2014-09-04 16:41:10 -0700 | [diff] [blame] | 40 | boolean isEnabled(); |
tom | ca20e0c | 2014-09-03 23:22:24 -0700 | [diff] [blame] | 41 | |
Thomas Vachuska | d16ce18 | 2014-10-29 17:25:29 -0700 | [diff] [blame] | 42 | /** |
| 43 | * Returns the port type. |
| 44 | * |
| 45 | * @return port type |
| 46 | */ |
| 47 | Type type(); |
| 48 | |
| 49 | /** |
| 50 | * Returns the current port speed in Mbps. |
| 51 | * |
| 52 | * @return current port speed |
| 53 | */ |
| 54 | long portSpeed(); |
| 55 | |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 56 | } |