Interface MembershipProviderBabelProtocol

All Superinterfaces:

BabelProtocol

public interface MembershipProviderBabelProtocol
extends BabelProtocol

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

A membership provider manages the set of active neighbours and notifies consumer protocols of changes:

• Call neighbourUp(Babel, BabelNode) when a node joins to notify all consumers.
• Call neighbourDown(Babel, BabelNode) when a node leaves to notify all consumers.
• Override getNeighbours(Class) to respond to MembershipConsumerBabelProtocol.askNeighbourSet(Babel) requests.

A MembershipProviderExtensionFactory must be registered with the BabelBootstrap for getNeighbours to be invoked automatically on AskNeighbourSet events.

See Also:

• MembershipConsumerBabelProtocol
• MembershipProviderExtensionFactory

Method Summary

Modifier and Type	Method	Description
default void	getNeighbours(Class<? extends MembershipConsumerBabelProtocol> askingProtocol)	Called by the MembershipProviderExtension when a consumer protocol requests the current neighbour set via MembershipConsumerBabelProtocol.askNeighbourSet(Babel).
default void	neighbourDown(Babel runtime, BabelNode node)	Notifies all registered consumer protocols that node has left the overlay by dispatching a NeighbourDown event.
default void	neighbourUp(Babel runtime, BabelNode node)	Notifies all registered consumer protocols that node has joined the overlay by dispatching a NeighbourUp event.

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

default void neighbourUp(Babel runtime,
 BabelNode node)

Notifies all registered consumer protocols that node has joined the overlay by dispatching a NeighbourUp event.

Parameters:

runtime - the Babel runtime used to dispatch the event

node - the new neighbour

neighbourDown

default void neighbourDown(Babel runtime,
 BabelNode node)

Notifies all registered consumer protocols that node has left the overlay by dispatching a NeighbourDown event.

Parameters:

runtime - the Babel runtime used to dispatch the event

node - the neighbour that left

getNeighbours

default void getNeighbours(Class<? extends MembershipConsumerBabelProtocol> askingProtocol)

Called by the MembershipProviderExtension when a consumer protocol requests the current neighbour set via MembershipConsumerBabelProtocol.askNeighbourSet(Babel).

The default implementation is a no-op. Override to collect the current neighbour set and call MembershipConsumerBabelProtocol.setNeighbours(Set) on the asking protocol.

Parameters:

askingProtocol - the class of the consumer protocol requesting the neighbour set