Interface BroadcastConsumerBabelProtocol

All Superinterfaces:

BabelProtocol

public interface BroadcastConsumerBabelProtocol
extends BabelProtocol

Marker interface for protocols that consume a broadcast service.

A protocol implementing this interface can:

• Call broadcast(Babel, BabelMessage) to send a message to all members of the overlay via the configured broadcast provider.
• Annotate methods with @UponBroadcastDeliver to receive messages delivered by the broadcast provider.

For the annotation handling to work, a BroadcastConsumerExtensionFactory must be registered with the BabelBootstrap for this protocol class.

See Also:

• BroadcastProviderBabelProtocol
• BroadcastConsumerExtensionFactory

Method Summary

Modifier and Type	Method	Description
default void	broadcast(Babel runtime, BabelMessage message)	Sends message to all members of the overlay by routing a BroadcastRequest event to the registered broadcast provider.

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

broadcast

default void broadcast(Babel runtime,
 BabelMessage message)

Sends message to all members of the overlay by routing a BroadcastRequest event to the registered broadcast provider.

Parameters:

runtime - the Babel runtime used to dispatch the request

message - the message to broadcast