Package io.atomix.cluster.discovery

Class MulticastDiscoveryProvider

java.lang.Object

io.atomix.utils.event.AbstractListenerManager<NodeDiscoveryEvent,NodeDiscoveryEventListener>

io.atomix.cluster.discovery.MulticastDiscoveryProvider

All Implemented Interfaces:

NodeDiscoveryProvider, io.atomix.utils.config.Configured<NodeDiscoveryConfig>, io.atomix.utils.event.ListenerService<NodeDiscoveryEvent,NodeDiscoveryEventListener>

public class MulticastDiscoveryProvider
extends io.atomix.utils.event.AbstractListenerManager<NodeDiscoveryEvent,NodeDiscoveryEventListener>
implements NodeDiscoveryProvider

Cluster membership provider that uses multicast for member discovery.

This implementation uses the BroadcastService internally and thus requires that multicast is enabled on the Atomix instance. Membership is determined by each node broadcasting to a multicast group, and phi accrual failure detectors are used to detect nodes joining and leaving the cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MulticastDiscoveryProvider.Type	Broadcast member location provider type.

Field Summary

Fields

Modifier and Type	Field	Description
static MulticastDiscoveryProvider.Type	TYPE

Constructor Summary

Constructors

Constructor	Description
MulticastDiscoveryProvider()
MulticastDiscoveryProvider(MulticastDiscoveryConfig config)

Method Summary

Modifier and Type	Method	Description
static MulticastDiscoveryBuilder	builder()	Returns a new multicast member location provider builder.
MulticastDiscoveryConfig	config()
Set<Node>	getNodes()	Returns the set of active nodes.
CompletableFuture<Void>	join(BootstrapService bootstrap, Node localNode)	Joins the cluster.
CompletableFuture<Void>	leave(Node localNode)	Leaves the cluster.

Methods inherited from class io.atomix.utils.event.AbstractListenerManager

addListener, removeListener

Methods inherited from class java.lang.Object

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

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

addListener, removeListener

Field Details

TYPE

public static final MulticastDiscoveryProvider.Type TYPE

Constructor Details

MulticastDiscoveryProvider

public MulticastDiscoveryProvider()

MulticastDiscoveryProvider

public MulticastDiscoveryProvider(MulticastDiscoveryConfig config)

Method Details

builder

public static MulticastDiscoveryBuilder builder()

Returns a new multicast member location provider builder.

Returns:

a new multicast location provider builder

config

public MulticastDiscoveryConfig config()

Specified by:

config in interface io.atomix.utils.config.Configured<NodeDiscoveryConfig>

getNodes

public Set<Node> getNodes()

Description copied from interface: NodeDiscoveryProvider

Returns the set of active nodes.

Specified by:

getNodes in interface NodeDiscoveryProvider

Returns:

the set of active nodes

join

public CompletableFuture<Void> join(BootstrapService bootstrap, Node localNode)

Description copied from interface: NodeDiscoveryProvider

Joins the cluster.

Specified by:

join in interface NodeDiscoveryProvider

Parameters:

bootstrap - the bootstrap service

localNode - the local node info

Returns:

a future to be completed once the join is complete

leave

public CompletableFuture<Void> leave(Node localNode)

Description copied from interface: NodeDiscoveryProvider

Leaves the cluster.

Specified by:

leave in interface NodeDiscoveryProvider

Parameters:

localNode - the local node info

Returns:

a future to be completed once the leave is complete