diff options
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/net/device/PortDescription.java')
-rw-r--r-- | framework/src/onos/core/api/src/main/java/org/onosproject/net/device/PortDescription.java | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/device/PortDescription.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/device/PortDescription.java new file mode 100644 index 00000000..3ed3efce --- /dev/null +++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/device/PortDescription.java @@ -0,0 +1,56 @@ +/* + * Copyright 2014 Open Networking Laboratory + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.onosproject.net.device; + +import org.onosproject.net.Description; +import org.onosproject.net.PortNumber; + +import static org.onosproject.net.Port.Type; + +/** + * Information about a port. + */ +public interface PortDescription extends Description { + + /** + * Returns the port number. + * + * @return port number + */ + PortNumber portNumber(); + + /** + * Indicates whether or not the port is up and active. + * + * @return true if the port is active and has carrier signal + */ + boolean isEnabled(); + + /** + * Returns the port type. + * + * @return port type + */ + Type type(); + + /** + * Returns the current port speed in Mbps. + * + * @return current port speed + */ + long portSpeed(); + +} |