diff options
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/net/Host.java')
-rw-r--r-- | framework/src/onos/core/api/src/main/java/org/onosproject/net/Host.java | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/Host.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/Host.java new file mode 100644 index 00000000..646f2283 --- /dev/null +++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/Host.java @@ -0,0 +1,68 @@ +/* + * 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; + +import org.onlab.packet.IpAddress; +import org.onlab.packet.MacAddress; +import org.onlab.packet.VlanId; + +import java.util.Set; + +/** + * Abstraction of an end-station host on the network, essentially a NIC. + */ +public interface Host extends Element { + + /** + * Host identification. + * + * @return host id + */ + @Override + HostId id(); + + /** + * Returns the host MAC address. + * + * @return mac address + */ + MacAddress mac(); + + /** + * Returns the VLAN ID tied to this host. + * + * @return VLAN ID value + */ + VlanId vlan(); + + /** + * Returns set of IP addresses currently bound to the host MAC address. + * + * @return set of IP addresses; empty if no IP address is bound + */ + Set<IpAddress> ipAddresses(); + + /** + * Returns the most recent host location where the host attaches to the + * network edge. + * + * @return host location + */ + HostLocation location(); + + // TODO: explore capturing list of recent locations to aid in mobility + +} |