io.atomix.cluster.discovery

Interface NodeDiscoveryProvider

All Superinterfaces:

Configured<NodeDiscoveryConfig>, ListenerService<NodeDiscoveryEvent,NodeDiscoveryEventListener>

All Known Implementing Classes:

BootstrapDiscoveryProvider, DnsDiscoveryProvider, MulticastDiscoveryProvider

public interface NodeDiscoveryProvider
extends ListenerService<NodeDiscoveryEvent,NodeDiscoveryEventListener>, Configured<NodeDiscoveryConfig>

Cluster membership provider.

The membership provider is an SPI that the ClusterMembershipService uses to locate new members joining the cluster. It provides a simple TCP Address for members which will be used by the ClusterMembershipService to exchange higher level Member information. Membership providers are responsible for providing an actively managed view of cluster membership.

See Also:

BootstrapDiscoveryProvider, MulticastDiscoveryProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NodeDiscoveryProvider.Type<C extends NodeDiscoveryConfig> Membership provider type.

Method Summary

Modifier and Type	Method and Description
java.util.Set<Node>	getNodes() Returns the set of active nodes.
java.util.concurrent.CompletableFuture<java.lang.Void>	join(BootstrapService bootstrap, Node localNode) Joins the cluster.
java.util.concurrent.CompletableFuture<java.lang.Void>	leave(Node localNode) Leaves the cluster.

Methods inherited from interface io.atomix.utils.event.ListenerService

addListener, removeListener

Methods inherited from interface io.atomix.utils.config.Configured

config

Method Detail

getNodes

java.util.Set<Node> getNodes()

Returns the set of active nodes.

Returns:

the set of active nodes

join

java.util.concurrent.CompletableFuture<java.lang.Void> join(BootstrapService bootstrap,
                                                            Node localNode)

Joins the cluster.

Parameters:

bootstrap - the bootstrap service

localNode - the local node info

Returns:

a future to be completed once the join is complete

leave

java.util.concurrent.CompletableFuture<java.lang.Void> leave(Node localNode)

Leaves the cluster.

Parameters:

localNode - the local node info

Returns:

a future to be completed once the leave is complete