org.onosproject.net.host

Interface HostProviderService

All Superinterfaces:

ProviderService<HostProvider>

public interface HostProviderService
extends ProviderService<HostProvider>

Means of conveying host information to the core.

Method Summary

Modifier and Type	Method and Description
default MacAddress	addPendingHostLocation(HostId hostId, HostLocation hostLocation) Notifies HostProviderService the beginning of pending host location verification and retrieves the unique MAC address for the probe.
void	hostDetected(HostId hostId, HostDescription hostDescription, boolean replaceIps) Notifies the core when a host has been detected on a network along with information that identifies the host location.
void	hostVanished(HostId hostId) Notifies the core when a host is no longer detected on a network.
void	removeIpFromHost(HostId hostId, IpAddress ipAddress) Notifies the core when an IP is no longer associated with a host.
void	removeLocationFromHost(HostId hostId, HostLocation location) Notifies the core when a location is no longer associated with a host.
default void	removePendingHostLocation(MacAddress probeMac) Notifies HostProviderService the end of pending host location verification.

Methods inherited from interface org.onosproject.net.provider.ProviderService

provider

Method Detail

hostDetected

void hostDetected(HostId hostId,
                  HostDescription hostDescription,
                  boolean replaceIps)

Notifies the core when a host has been detected on a network along with information that identifies the host location.

Parameters:

hostId - id of the host that been detected

hostDescription - description of host and its location

replaceIps - replace IP set if true, merge IP set otherwise

hostVanished

void hostVanished(HostId hostId)

Notifies the core when a host is no longer detected on a network.

Parameters:

hostId - id of the host that vanished

removeIpFromHost

void removeIpFromHost(HostId hostId,
                      IpAddress ipAddress)

Notifies the core when an IP is no longer associated with a host.

Parameters:

hostId - id of the host

ipAddress - ip address of host that vanished

removeLocationFromHost

void removeLocationFromHost(HostId hostId,
                            HostLocation location)

Notifies the core when a location is no longer associated with a host.

Parameters:

hostId - id of the host

location - location of host that vanished

addPendingHostLocation

default MacAddress addPendingHostLocation(HostId hostId,
                                          HostLocation hostLocation)

Notifies HostProviderService the beginning of pending host location verification and retrieves the unique MAC address for the probe.

Parameters:

hostId - ID of the host

hostLocation - the host location that is under verification

Returns:

probeMac, the source MAC address ONOS uses to probe the host

removePendingHostLocation

default void removePendingHostLocation(MacAddress probeMac)

Notifies HostProviderService the end of pending host location verification.

Parameters:

probeMac - the source MAC address ONOS uses to probe the host