Package io.hekate.election
Interface FollowerContext
-
- All Superinterfaces:
HekateSupport
public interface FollowerContext extends HekateSupport
Follower state context forCandidate
.For more details about the leader election process please see the documentation of
ElectionService
interface.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addListener(LeaderChangeListener listener)
Registers the leader change event listener.ClusterNode
leader()
Returns a node that is currently holding the leadership.ClusterNode
localNode()
Returns the local node where theCandidate
is running.boolean
removeListener(LeaderChangeListener listener)
Unregisters the specified listener if it was previously registered viaaddListener(LeaderChangeListener)
.-
Methods inherited from interface io.hekate.core.HekateSupport
hekate
-
-
-
-
Method Detail
-
leader
ClusterNode leader()
Returns a node that is currently holding the leadership.- Returns:
- Leader node.
-
localNode
ClusterNode localNode()
Returns the local node where theCandidate
is running.- Returns:
- Local node.
-
addListener
void addListener(LeaderChangeListener listener)
Registers the leader change event listener.The specified listener will be notified every time when some other node becomes a new leader.
This listener will be kept registered only while
candidate
stays in the follower state. Listener will be automatically unregistered whencandidate
switches to the leader state.- Parameters:
listener
- Listener.
-
removeListener
boolean removeListener(LeaderChangeListener listener)
Unregisters the specified listener if it was previously registered viaaddListener(LeaderChangeListener)
.- Parameters:
listener
- Listener.- Returns:
true
if listener was removed.
-
-