Interface MembershipConsumerBabelProtocol

All Superinterfaces:

BabelProtocol

public interface MembershipConsumerBabelProtocol
extends BabelProtocol

Interface for protocols that consume a membership (overlay neighbour) service.

Implementing protocols receive neighbour change notifications and can request a snapshot of the current neighbour set:

• neighbourUp(BabelNode) is called when a new neighbour joins.
• neigbourDown(BabelNode) is called when an existing neighbour leaves.
• askNeighbourSet(Babel) requests the full neighbour set from the provider; the reply is delivered via setNeighbours(Set).

A MembershipConsumerExtensionFactory must be registered with the BabelBootstrap for the callbacks to be wired automatically.

See Also:

• MembershipProviderBabelProtocol
• MembershipConsumerExtensionFactory

Method Summary

Modifier and Type	Method	Description
default void	askNeighbourSet(Babel runtime)	Requests the current set of neighbours from the membership provider by dispatching an AskNeighbourSet event.
void	neigbourDown(BabelNode node)	Called when neighbour node has left or become unreachable.
void	neighbourUp(BabelNode node)	Called when a new neighbour identified by node has joined the overlay and is now considered an active member.
default void	setNeighbours(Set<BabelNode> neighbours)	Called with the current neighbour set in response to a previous askNeighbourSet(Babel) call.

Methods inherited from interface BabelProtocol

connectionDown, connectionFailed, connectionUp, init, pause, resume, stop

Modifier and Type	Method	Description
default void	connectionDown(BabelNode peer, @Nullable Throwable cause)	Invoked when a previously established connection to peer has been closed, either locally or remotely.
default void	connectionFailed(BabelNode peer, @Nullable Throwable cause)	Invoked when an outgoing connection attempt to peer failed before a connection could be established.
default void	connectionUp(BabelNode peer)	Invoked when an outgoing connection to peer has been established successfully through the protocol's assigned BabelChannel.
default void	init(Babel runtime, ComposedBabelChannel channel)	Initiates the protocol's logic and execution.
default void	pause()	Suspends the protocol's operations.
default void	resume(Babel runtime, ComposedBabelChannel channel)	Reinstates the protocol's execution from a paused state.
default void	stop()	Completely halt the protocols execution.

Method Details

neighbourUp

void neighbourUp(BabelNode node)

Called when a new neighbour identified by node has joined the overlay and is now considered an active member.

Parameters:

node - the newly joined neighbour

neigbourDown

void neigbourDown(BabelNode node)

Called when neighbour node has left or become unreachable.

Parameters:

node - the neighbour that has gone down

askNeighbourSet

default void askNeighbourSet(Babel runtime)

Requests the current set of neighbours from the membership provider by dispatching an AskNeighbourSet event. The provider responds asynchronously via setNeighbours(Set).

Parameters:

runtime - the Babel runtime used to dispatch the request

setNeighbours

default void setNeighbours(Set<BabelNode> neighbours)

Called with the current neighbour set in response to a previous askNeighbourSet(Babel) call. The default implementation is a no-op; override to process the received set.

Parameters:

neighbours - the current set of active neighbours