org.onosproject.net.device

Interface DeviceHandshaker

All Superinterfaces:

Behaviour, DeviceConnect, HandlerBehaviour

@Beta
public interface DeviceHandshaker
extends DeviceConnect

Behavior to test device's reachability and change the mastership role on that device.

Method Summary

Modifier and Type	Method and Description
default void	addDeviceAgentListener(ProviderId providerId, DeviceAgentListener listener) Adds a device agent listener for the given provider ID.
MastershipRole	getRole() Returns the last known mastership role agreed by the device for this node.
CompletableFuture<Boolean>	isReachable() Checks the reachability (connectivity) of a device.
default void	removeDeviceAgentListener(ProviderId providerId) Removes a device agent listener previously registered for the given provider ID.
void	roleChanged(MastershipRole newRole) Notifies the device a mastership role change as decided by the core.

Methods inherited from interface org.onosproject.net.driver.DeviceConnect

connect, disconnect, isConnected

Methods inherited from interface org.onosproject.net.driver.HandlerBehaviour

handler, setHandler

Methods inherited from interface org.onosproject.net.driver.Behaviour

data, setData

Method Detail

isReachable

CompletableFuture<Boolean> isReachable()

Checks the reachability (connectivity) of a device. Reachability, unlike availability, denotes whether THIS particular node can send messages and receive replies from the specified device.

Returns:

CompletableFuture eventually true if reachable, false otherwise

roleChanged

void roleChanged(MastershipRole newRole)

Notifies the device a mastership role change as decided by the core. The implementation of this method should trigger a DeviceAgentEvent signaling the mastership role accepted by the device.

Parameters:

newRole - new mastership role

getRole

MastershipRole getRole()

Returns the last known mastership role agreed by the device for this node.

Returns:

mastership role

addDeviceAgentListener

default void addDeviceAgentListener(ProviderId providerId,
                                    DeviceAgentListener listener)

Adds a device agent listener for the given provider ID.

Parameters:

providerId - provider ID

listener - device agent listener

removeDeviceAgentListener

default void removeDeviceAgentListener(ProviderId providerId)

Removes a device agent listener previously registered for the given provider ID.

Parameters:

providerId - provider ID