Interface BroadcastProviderBabelProtocol

All Superinterfaces:

BabelProtocol

public interface BroadcastProviderBabelProtocol
extends BabelProtocol

Interface for protocols that implement a broadcast service.

A broadcast provider receives BroadcastRequest events from consumer protocols (via the BroadcastProviderExtension), performs the actual dissemination (e.g., gossip, flooding, tree-based multicast), and calls deliverMessage(Babel, BabelMessage, BabelNode) for each message that should be delivered to the local consumers.

To wire up a provider, register a BroadcastProviderExtensionFactory (or BroadcastProviderExtension.newFactory()) with the BabelBootstrap.

See Also:

• BroadcastConsumerBabelProtocol
• BroadcastProviderExtension

Method Summary

Modifier and Type	Method	Description
default void	deliverMessage(Babel runtime, BabelMessage message, BabelNode node)	Delivers a broadcast-received message to all local consumer protocols by dispatching a BroadcastDeliverEvent through the runtime.
void	uponBroadcastRequest(BabelMessage message)	Called by the BroadcastProviderExtension when a consumer protocol requests that message be broadcast to all overlay members.

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

uponBroadcastRequest

void uponBroadcastRequest(BabelMessage message)

Called by the BroadcastProviderExtension when a consumer protocol requests that message be broadcast to all overlay members.

Parameters:

message - the message to disseminate

deliverMessage

default void deliverMessage(Babel runtime,
 BabelMessage message,
 BabelNode node)

Delivers a broadcast-received message to all local consumer protocols by dispatching a BroadcastDeliverEvent through the runtime.

Parameters:

runtime - the Babel runtime used to dispatch the delivery event

message - the message to deliver locally

node - the original sender of the broadcast