io.atomix.cluster.protocol

Class PhiMembershipProtocol

java.lang.Object

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

io.atomix.cluster.protocol.PhiMembershipProtocol

All Implemented Interfaces:

GroupMembershipProtocol, Configured<GroupMembershipProtocolConfig>, ListenerService<GroupMembershipEvent,GroupMembershipEventListener>

public class PhiMembershipProtocol
extends AbstractListenerManager<GroupMembershipEvent,GroupMembershipEventListener>
implements GroupMembershipProtocol

Gossip based group membership protocol.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static PhiMembershipProtocol.Type	TYPE

Constructor Summary

Constructors

Constructor and Description
PhiMembershipProtocol(PhiMembershipProtocolConfig config)

Method Summary

Modifier and Type	Method and Description
static PhiMembershipProtocolBuilder	builder() Creates a new bootstrap provider builder.
GroupMembershipProtocolConfig	config()
Member	getMember(MemberId memberId) Returns the specified member.
java.util.Set<Member>	getMembers() Returns the set of current cluster members.
java.util.concurrent.CompletableFuture<java.lang.Void>	join(BootstrapService bootstrap, NodeDiscoveryService discovery, Member member) Joins the cluster.
java.util.concurrent.CompletableFuture<java.lang.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 Detail

TYPE

public static final PhiMembershipProtocol.Type TYPE

Constructor Detail

PhiMembershipProtocol

public PhiMembershipProtocol(PhiMembershipProtocolConfig config)

Method Detail

builder

public static PhiMembershipProtocolBuilder builder()

Creates a new bootstrap provider builder.

Returns:

a new bootstrap provider builder

config

public GroupMembershipProtocolConfig config()

Specified by:

config in interface Configured<GroupMembershipProtocolConfig>

getMembers

public java.util.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 java.util.concurrent.CompletableFuture<java.lang.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 java.util.concurrent.CompletableFuture<java.lang.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