org.onosproject.net.host

Interface HostService

public interface HostService

Service for interacting with the inventory of end-station hosts.

Method Summary

Modifier and Type	Method and Description
void	addListener(HostListener listener) Adds the specified host listener.
Set<PortAddresses>	getAddressBindings() Returns the addresses information for all connection points.
Set<PortAddresses>	getAddressBindingsForPort(ConnectPoint connectPoint) Retrieves the addresses that have been bound to the given connection point.
Set<Host>	getConnectedHosts(ConnectPoint connectPoint) Returns the set of hosts whose most recent location is the specified connection point.
Set<Host>	getConnectedHosts(DeviceId deviceId) Returns the set of hosts whose most recent location is the specified infrastructure device.
Host	getHost(HostId hostId) Returns the host with the specified identifier.
int	getHostCount() Returns the number of end-station hosts known to the system.
Iterable<Host>	getHosts() Returns a collection of all end-station hosts.
Set<Host>	getHostsByIp(org.onlab.packet.IpAddress ip) Returns the set of hosts that have the specified IP address.
Set<Host>	getHostsByMac(org.onlab.packet.MacAddress mac) Returns the set of hosts that have the specified MAC address.
Set<Host>	getHostsByVlan(org.onlab.packet.VlanId vlanId) Returns the set of hosts that belong to the specified VLAN.
void	removeListener(HostListener listener) Removes the specified host listener.
void	requestMac(org.onlab.packet.IpAddress ip) Requests the host service to resolve the MAC address for the given IP address.
void	startMonitoringIp(org.onlab.packet.IpAddress ip) Requests the host service to monitor hosts with the given IP address and notify listeners of changes.
void	stopMonitoringIp(org.onlab.packet.IpAddress ip) Stops the host service from monitoring an IP address.

Method Detail

getHostCount

int getHostCount()

Returns the number of end-station hosts known to the system.

Returns:

number of end-station hosts

getHosts

Iterable<Host> getHosts()

Returns a collection of all end-station hosts.

Returns:

collection of hosts

getHost

Host getHost(HostId hostId)

Returns the host with the specified identifier.

Parameters:

hostId - host identifier

Returns:

host or null if one with the given identifier is not known

getHostsByVlan

Set<Host> getHostsByVlan(org.onlab.packet.VlanId vlanId)

Returns the set of hosts that belong to the specified VLAN.

Parameters:

vlanId - vlan identifier

Returns:

set of hosts in the given vlan id

getHostsByMac

Set<Host> getHostsByMac(org.onlab.packet.MacAddress mac)

Returns the set of hosts that have the specified MAC address.

Parameters:

mac - mac address

Returns:

set of hosts with the given mac

getHostsByIp

Set<Host> getHostsByIp(org.onlab.packet.IpAddress ip)

Returns the set of hosts that have the specified IP address.

Parameters:

ip - ip address

Returns:

set of hosts with the given IP

getConnectedHosts

Set<Host> getConnectedHosts(ConnectPoint connectPoint)

Returns the set of hosts whose most recent location is the specified connection point.

Parameters:

connectPoint - connection point

Returns:

set of hosts connected to the connection point

getConnectedHosts

Set<Host> getConnectedHosts(DeviceId deviceId)

Returns the set of hosts whose most recent location is the specified infrastructure device.

Parameters:

deviceId - device identifier

Returns:

set of hosts connected to the device

startMonitoringIp

void startMonitoringIp(org.onlab.packet.IpAddress ip)

Requests the host service to monitor hosts with the given IP address and notify listeners of changes.

Parameters:

ip - IP address of the host to monitor

stopMonitoringIp

void stopMonitoringIp(org.onlab.packet.IpAddress ip)

Stops the host service from monitoring an IP address.

Parameters:

ip - IP address to stop monitoring

requestMac

void requestMac(org.onlab.packet.IpAddress ip)

Requests the host service to resolve the MAC address for the given IP address. This will trigger a notification to the host listeners if the MAC address is found.

Parameters:

ip - IP address to find the MAC address for

getAddressBindings

Set<PortAddresses> getAddressBindings()

Returns the addresses information for all connection points.

Returns:

the set of address bindings for all connection points

getAddressBindingsForPort

Set<PortAddresses> getAddressBindingsForPort(ConnectPoint connectPoint)

Retrieves the addresses that have been bound to the given connection point.

Parameters:

connectPoint - the connection point to retrieve address bindings for

Returns:

addresses bound to the port

addListener

void addListener(HostListener listener)

Adds the specified host listener.

Parameters:

listener - host listener

removeListener

void removeListener(HostListener listener)

Removes the specified host listener.

Parameters:

listener - host listener