org.onosproject.mastership

Interface MastershipService

public interface MastershipService

Service responsible for determining the controller instance mastership of a device in a clustered environment. This is the central authority for determining mastership, but is not responsible for actually applying it to the devices; this falls on the device service.

Method Summary

Modifier and Type	Method and Description
void	addListener(MastershipListener listener) Adds the specified mastership change listener.
Set<DeviceId>	getDevicesOf(NodeId nodeId) Returns the devices for which a controller is master.
MastershipRole	getLocalRole(DeviceId deviceId) Returns the role of the local node for the specified device, without triggering master selection.
NodeId	getMasterFor(DeviceId deviceId) Returns the current master for a given device.
RoleInfo	getNodesFor(DeviceId deviceId) Returns controllers connected to a given device, in order of preference.
void	relinquishMastership(DeviceId deviceId) Abandons mastership of the specified device on the local node thus forcing selection of a new master.
void	removeListener(MastershipListener listener) Removes the specified mastership change listener.
MastershipRole	requestRoleFor(DeviceId deviceId) Returns the mastership status of the local controller for a given device forcing master selection if necessary.

Method Detail

getLocalRole

MastershipRole getLocalRole(DeviceId deviceId)

Returns the role of the local node for the specified device, without triggering master selection.

Parameters:

deviceId - the the identifier of the device

Returns:

role of the current node

requestRoleFor

MastershipRole requestRoleFor(DeviceId deviceId)

Returns the mastership status of the local controller for a given device forcing master selection if necessary.

Parameters:

deviceId - the the identifier of the device

Returns:

the role of this controller instance

relinquishMastership

void relinquishMastership(DeviceId deviceId)

Abandons mastership of the specified device on the local node thus forcing selection of a new master. If the local node is not a master for this device, no master selection will occur.

Parameters:

deviceId - the identifier of the device

getMasterFor

NodeId getMasterFor(DeviceId deviceId)

Returns the current master for a given device.

Parameters:

deviceId - the identifier of the device

Returns:

the ID of the master controller for the device

getNodesFor

RoleInfo getNodesFor(DeviceId deviceId)

Returns controllers connected to a given device, in order of preference. The first entry in the list is the current master.

Parameters:

deviceId - the identifier of the device

Returns:

a list of controller IDs

getDevicesOf

Set<DeviceId> getDevicesOf(NodeId nodeId)

Returns the devices for which a controller is master.

Parameters:

nodeId - the ID of the controller

Returns:

a set of device IDs

addListener

void addListener(MastershipListener listener)

Adds the specified mastership change listener.

Parameters:

listener - the mastership listener

removeListener

void removeListener(MastershipListener listener)

Removes the specified mastership change listener.

Parameters:

listener - the mastership listener