Class BroadcastProviderExtension

java.lang.Object

pt.unl.fct.di.novasys.babel2.core.broadcast.BroadcastProviderExtension

All Implemented Interfaces:

ProtocolExtension<BroadcastProviderBabelProtocol>, EventHandler<ProtocolEvent>

public class BroadcastProviderExtension
extends Object
implements ProtocolExtension<BroadcastProviderBabelProtocol>

ProtocolExtension that routes BroadcastRequest events from consumer protocols to the associated BroadcastProviderBabelProtocol.

When a consumer protocol calls broadcast, a BroadcastRequest event is dispatched through the runtime. This extension intercepts those events and forwards each one to uponBroadcastRequest on the provider protocol.

The extension does not handle any method annotations; its sole purpose is to bridge the BroadcastRequest event to the provider's callback.

Register via BroadcastProviderExtensionFactory (or the convenience method newFactory()) on the BabelBootstrap.

See Also:

• BroadcastProviderBabelProtocol
• BroadcastProviderExtensionFactory

Field Summary

Fields inherited from interface EventHandler

HANDLER_METHOD_NAME

Modifier and Type	Field	Description
static final String	HANDLER_METHOD_NAME	The name of the functional method.

Constructor Summary

Constructors

Constructor	Description
BroadcastProviderExtension(BroadcastProviderBabelProtocol protocol)	Constructs a BroadcastProviderExtension bound to the given provider protocol.

Method Summary

Modifier and Type	Method	Description
Set<Class<? extends ProtocolEvent>>	eventsClass()	Returns an empty list because this extension does not declare any method annotations.
void	handleEvent(ProtocolEvent event)	Handles a BroadcastRequest by forwarding the contained message to BroadcastProviderBabelProtocol.uponBroadcastRequest(BabelMessage).
static ProtocolExtensionFactory	newFactory()	Creates a new BroadcastProviderExtensionFactory suitable for registration with BabelBootstrap#registerExtension.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ProtocolExtension

annotationClass, register

Modifier and Type	Method	Description
default Set<Class<? extends Annotation>>	annotationClass()	Returns the set of method-level annotation types that this extension processes.
default void	register(Method method, MethodHandles.Lookup lookup, BroadcastProviderBabelProtocol protocol, BabelProtocolHolder holder, Annotation annotation)	Called by SharedExecutorProtocolHolder during initialisation for each method on the protocol that carries one of the annotations returned by ProtocolExtension.annotationClass().

Constructor Details

BroadcastProviderExtension

public BroadcastProviderExtension(BroadcastProviderBabelProtocol protocol)

Constructs a BroadcastProviderExtension bound to the given provider protocol.

Parameters:

protocol - the broadcast provider this extension will forward requests to; must not be null

Throws:

NullPointerException - if protocol is null

Method Details

handleEvent

public void handleEvent(ProtocolEvent event)

Handles a BroadcastRequest by forwarding the contained message to BroadcastProviderBabelProtocol.uponBroadcastRequest(BabelMessage).

Specified by:

handleEvent in interface EventHandler<ProtocolEvent>

Specified by:

handleEvent in interface ProtocolExtension<BroadcastProviderBabelProtocol>

Parameters:

event - the event to handle; must be a BroadcastRequest

Throws:

IllegalArgumentException - if event is not a BroadcastRequest

eventsClass

public Set<Class<? extends ProtocolEvent>> eventsClass()

Returns an empty list because this extension does not declare any method annotations.

Specified by:

eventsClass in interface ProtocolExtension<BroadcastProviderBabelProtocol>

Returns:

an empty list

newFactory

public static ProtocolExtensionFactory newFactory()

Creates a new BroadcastProviderExtensionFactory suitable for registration with BabelBootstrap#registerExtension.

Returns:

a fresh BroadcastProviderExtensionFactory