Class MembershipConsumerExtension

java.lang.Object

pt.unl.fct.di.novasys.babel2.core.membership.MembershipConsumerExtension

All Implemented Interfaces:

ProtocolExtension<MembershipConsumerBabelProtocol>, EventHandler<ProtocolEvent>

public class MembershipConsumerExtension
extends Object
implements ProtocolExtension<MembershipConsumerBabelProtocol>

ProtocolExtension that delivers membership change events to MembershipConsumerBabelProtocol instances.

This extension intercepts three event types emitted by a membership provider:

• NeighbourUp — forwarded to MembershipConsumerBabelProtocol.neighbourUp(BabelNode).
• NeighbourDown — forwarded to MembershipConsumerBabelProtocol.neigbourDown(BabelNode).
• NeighbourSet — forwarded to MembershipConsumerBabelProtocol.setNeighbours(Set), providing the current neighbour snapshot requested via MembershipConsumerBabelProtocol.askNeighbourSet(Babel).

The extension does not handle any method-level annotations.

Register via MembershipConsumerExtensionFactory on the BabelBootstrap.

See Also:

• MembershipConsumerBabelProtocol
• MembershipConsumerExtensionFactory

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
MembershipConsumerExtension(MembershipConsumerBabelProtocol protocol)	Constructs a MembershipConsumerExtension for the given consumer protocol.

Method Summary

Modifier and Type	Method	Description
Set<Class<? extends ProtocolEvent>>	eventsClass()	Returns the set of ProtocolEvent types that this extension handles.
void	handleEvent(ProtocolEvent event)	Dispatches a membership event to the appropriate callback on the consumer protocol.

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, MembershipConsumerBabelProtocol 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

MembershipConsumerExtension

public MembershipConsumerExtension(MembershipConsumerBabelProtocol protocol)

Constructs a MembershipConsumerExtension for the given consumer protocol.

Parameters:

protocol - the consumer protocol that will receive membership change callbacks

Method Details

handleEvent

public void handleEvent(ProtocolEvent event)

Dispatches a membership event to the appropriate callback on the consumer protocol.

Specified by:

handleEvent in interface EventHandler<ProtocolEvent>

Specified by:

handleEvent in interface ProtocolExtension<MembershipConsumerBabelProtocol>

Parameters:

event - the event to handle; must be one of NeighbourUp, NeighbourDown, or NeighbourSet

Throws:

IllegalArgumentException - if event is not a recognised membership event

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<MembershipConsumerBabelProtocol>

Returns:

a list of event classes; may be empty