io.vertx.core.spi.cluster

Interface NodeSelector

All Superinterfaces:

VertxServiceProvider

public interface NodeSelector
extends VertxServiceProvider

Used by the clustered EventBus to select a node for a given message.

This selector is skipped only when the user raises the DeliveryOptions.setLocalOnly(boolean) flag. Consequently, implementations must be aware of local EventBus registrations.

Method Summary

Modifier and Type	Method and Description
void	eventBusStarted() Invoked after the clustered EventBus has started.
default void	init(io.vertx.core.impl.VertxBuilder builder) Let the provider initialize the Vert.x builder.
void	init(Vertx vertx, ClusterManager clusterManager) Invoked before the vertx instance tries to join the cluster.
void	registrationsLost() Invoked by the ClusterManager when some handler registrations have been lost.
void	registrationsUpdated(RegistrationUpdateEvent event) Invoked by the ClusterManager when messaging handler registrations are added or removed.
void	selectForPublish(Message<?> message, Promise<Iterable<String>> promise) Select a node for publishing the given message.
void	selectForSend(Message<?> message, Promise<String> promise) Select a node for sending the given message.
default boolean	wantsUpdatesFor(String address) Invoked by the ClusterManager to determine if the node selector wants updates for the given address.

Method Detail

init

default void init(io.vertx.core.impl.VertxBuilder builder)

Description copied from interface: VertxServiceProvider

Let the provider initialize the Vert.x builder.

Specified by:

init in interface VertxServiceProvider

Parameters:

builder - the builder

init

void init(Vertx vertx,
          ClusterManager clusterManager)

Invoked before the vertx instance tries to join the cluster.

eventBusStarted

void eventBusStarted()

Invoked after the clustered EventBus has started.

selectForSend

void selectForSend(Message<?> message,
                   Promise<String> promise)

Select a node for sending the given message.

The provided promise needs to be completed with Promise.tryComplete(T) and Promise.tryFail(java.lang.Throwable) as it might completed outside the selector.

Throws:

IllegalArgumentException - if Message.isSend() returns false

selectForPublish

void selectForPublish(Message<?> message,
                      Promise<Iterable<String>> promise)

Select a node for publishing the given message.

The provided promise needs to be completed with Promise.tryComplete(T) and Promise.tryFail(java.lang.Throwable) as it might completed outside the selector.

Throws:

IllegalArgumentException - if Message.isSend() returns true

registrationsUpdated

void registrationsUpdated(RegistrationUpdateEvent event)

Invoked by the ClusterManager when messaging handler registrations are added or removed.

registrationsLost

void registrationsLost()

Invoked by the ClusterManager when some handler registrations have been lost.

wantsUpdatesFor

default boolean wantsUpdatesFor(String address)

Invoked by the ClusterManager to determine if the node selector wants updates for the given address.

Parameters:

address - the event bus address

Returns:

true if the node selector wants updates for the given address, false otherwise