Package io.atomix.cluster.protocol

Class SwimMembershipProtocol

java.lang.Object

io.atomix.utils.event.AbstractListenerManager<GroupMembershipEvent,GroupMembershipEventListener>

io.atomix.cluster.protocol.SwimMembershipProtocol

All Implemented Interfaces:

GroupMembershipProtocol, io.atomix.utils.config.Configured<GroupMembershipProtocolConfig>, io.atomix.utils.event.ListenerService<GroupMembershipEvent,GroupMembershipEventListener>

public class SwimMembershipProtocol
extends io.atomix.utils.event.AbstractListenerManager<GroupMembershipEvent,GroupMembershipEventListener>
implements GroupMembershipProtocol

SWIM group membership protocol implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SwimMembershipProtocol.Type	Bootstrap member location provider type.

Field Summary

Fields

Modifier and Type	Field	Description
static SwimMembershipProtocol.Type	TYPE

Method Summary

Modifier and Type	Method	Description
static SwimMembershipProtocolBuilder	builder()	Creates a new bootstrap provider builder.
SwimMembershipProtocolConfig	config()
Member	getMember(MemberId memberId)	Returns the specified member.
Set<Member>	getMembers()	Returns the set of current cluster members.
CompletableFuture<Void>	join(BootstrapService bootstrap, NodeDiscoveryService discovery, Member member)	Joins the cluster.
CompletableFuture<Void>	leave(Member member)	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 SwimMembershipProtocol.Type TYPE

Method Details

builder

public static SwimMembershipProtocolBuilder builder()

Creates a new bootstrap provider builder.

Returns:

a new bootstrap provider builder

config

public SwimMembershipProtocolConfig config()

Specified by:

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

getMembers

public Set<Member> getMembers()

Description copied from interface: GroupMembershipProtocol

Returns the set of current cluster members.

Specified by:

getMembers in interface GroupMembershipProtocol

Returns:

set of cluster members

getMember

public Member getMember(MemberId memberId)

Description copied from interface: GroupMembershipProtocol

Returns the specified member.

Specified by:

getMember in interface GroupMembershipProtocol

Parameters:

memberId - the member identifier

Returns:

the member or null if no node with the given identifier exists

join

public CompletableFuture<Void> join(BootstrapService bootstrap, NodeDiscoveryService discovery, Member member)

Description copied from interface: GroupMembershipProtocol

Joins the cluster.

Specified by:

join in interface GroupMembershipProtocol

Parameters:

bootstrap - the bootstrap service

discovery - the discovery service

member - the local member info

Returns:

a future to be completed once the join is complete

leave

public CompletableFuture<Void> leave(Member member)

Description copied from interface: GroupMembershipProtocol

Leaves the cluster.

Specified by:

leave in interface GroupMembershipProtocol

Parameters:

member - the local member info

Returns:

a future to be completed once the leave is complete