org.onosproject.cluster

Interface LeadershipService

public interface LeadershipService

Service for leader election. Leadership contests are organized around topics. A instance can join the leadership race for a topic or withdraw from a race it has previously joined. Listeners can be added to receive notifications asynchronously for various leadership contests.

Method Summary

Modifier and Type	Method and Description
void	addListener(LeadershipEventListener listener) Registers a event listener to be notified of leadership events.
NodeId	getLeader(String path) Gets the most recent leader for the topic.
Map<String,Leadership>	getLeaderBoard()
void	removeListener(LeadershipEventListener listener) Unregisters a event listener for leadership events.
void	runForLeadership(String path) Joins the leadership contest.
void	withdraw(String path) Withdraws from a leadership contest.

Method Detail

getLeader

NodeId getLeader(String path)

Gets the most recent leader for the topic.

Parameters:

path - topic

Returns:

nodeId of the leader, null if so such topic exists.

runForLeadership

void runForLeadership(String path)

Joins the leadership contest.

Parameters:

path - topic for which this controller node wishes to be a leader.

withdraw

void withdraw(String path)

Withdraws from a leadership contest.

Parameters:

path - topic for which this controller node no longer wishes to be a leader.

getLeaderBoard

Map<String,Leadership> getLeaderBoard()

addListener

void addListener(LeadershipEventListener listener)

Registers a event listener to be notified of leadership events.

Parameters:

listener - listener that will asynchronously notified of leadership events.

removeListener

void removeListener(LeadershipEventListener listener)

Unregisters a event listener for leadership events.

Parameters:

listener - listener to be removed.