Class BroadcastConsumerExtension

java.lang.Object

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

All Implemented Interfaces:

ProtocolExtension<BroadcastConsumerBabelProtocol>, EventHandler<ProtocolEvent>

public class BroadcastConsumerExtension
extends Object
implements ProtocolExtension<BroadcastConsumerBabelProtocol>

ProtocolExtension that wires up broadcast-delivery handling for BroadcastConsumerBabelProtocol instances.

During initialisation it scans the protocol for methods annotated with @UponBroadcastDeliver and builds a typed BroadcastDeliverHandler for each one. At runtime, incoming BroadcastDeliverEvent events are dispatched to the matching handler based on the carried message type.

Register via BroadcastConsumerExtensionFactory on the BabelBootstrap.

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
BroadcastConsumerExtension(BroadcastConsumerBabelProtocol protocol)	Constructs a BroadcastConsumerExtension for the given protocol.

Method Summary

Modifier and Type	Method	Description
Set<Class<? extends Annotation>>	annotationClass()	Returns the set of method-level annotation types that this extension processes.
Set<Class<? extends ProtocolEvent>>	eventsClass()	Returns the set of ProtocolEvent types that this extension handles.
void	handleEvent(ProtocolEvent event)	Dispatches a ProtocolEvent that was previously claimed by this extension (because its type is listed in ProtocolExtension.eventsClass()).
void	register(Method method, MethodHandles.Lookup lookup, BroadcastConsumerBabelProtocol 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().

Methods inherited from class Object

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

Constructor Details

BroadcastConsumerExtension

public BroadcastConsumerExtension(BroadcastConsumerBabelProtocol protocol)

Constructs a BroadcastConsumerExtension for the given protocol.

Parameters:

protocol - the consumer protocol this extension will augment; must not be null

Method Details

annotationClass

public Set<Class<? extends Annotation>> annotationClass()

Description copied from interface: ProtocolExtension

Returns the set of method-level annotation types that this extension processes. The framework scans protocol methods for these annotations during initialisation and calls ProtocolExtension.register(Method, MethodHandles.Lookup, T, BabelProtocolHolder, Annotation) for each match.

Specified by:

annotationClass in interface ProtocolExtension<BroadcastConsumerBabelProtocol>

Returns:

a list of annotation classes; may be empty if the extension does not use method annotations

register

public void register(Method method,
 MethodHandles.Lookup lookup,
 BroadcastConsumerBabelProtocol protocol,
 BabelProtocolHolder holder,
 Annotation annotation)

Description copied from interface: ProtocolExtension

Called by SharedExecutorProtocolHolder during initialisation for each method on the protocol that carries one of the annotations returned by ProtocolExtension.annotationClass(). Implementations should build and store a handler for that method.

Specified by:

register in interface ProtocolExtension<BroadcastConsumerBabelProtocol>

Parameters:

method - the annotated method on the protocol class

lookup - a MethodHandles.Lookup scoped to the protocol's class, suitable for creating lambda method handles

protocol - the concrete protocol instance

holder - the SharedExecutorProtocolHolder wrapping the protocol, which exposes AbstractBabelProtocolHolder.createHandler(Method, MethodHandles.Lookup, Class, Class, String, Class[], Class[]) for building typed functional-interface handlers

annotation - the Annotation that is associated with this method.

handleEvent

public void handleEvent(ProtocolEvent event)

Description copied from interface: ProtocolExtension

Dispatches a ProtocolEvent that was previously claimed by this extension (because its type is listed in ProtocolExtension.eventsClass()).

Specified by:

handleEvent in interface EventHandler<ProtocolEvent>

Specified by:

handleEvent in interface ProtocolExtension<BroadcastConsumerBabelProtocol>

Parameters:

event - the event to handle; its runtime type is guaranteed to be one of the types returned by ProtocolExtension.eventsClass()

eventsClass

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

Description copied from interface: ProtocolExtension

Returns the set of ProtocolEvent types that this extension handles. Events of these types are routed to ProtocolExtension.handleEvent(ProtocolEvent) instead of the protocol's own @UponBabelEvent-annotated handlers.

Specified by:

eventsClass in interface ProtocolExtension<BroadcastConsumerBabelProtocol>

Returns:

a list of event classes; may be empty