io.atomix.cluster.protocol

Interface GroupMembershipProtocol

All Superinterfaces:

Configured<GroupMembershipProtocolConfig>, ListenerService<GroupMembershipEvent,GroupMembershipEventListener>

All Known Implementing Classes:

HeartbeatMembershipProtocol, SwimMembershipProtocol

public interface GroupMembershipProtocol
extends ListenerService<GroupMembershipEvent,GroupMembershipEventListener>, Configured<GroupMembershipProtocolConfig>

Group membership protocol.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	GroupMembershipProtocol.Type<C extends GroupMembershipProtocolConfig> Group membership protocol type.

Method Summary

Modifier and Type	Method and Description
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 localMember) Joins the cluster.
java.util.concurrent.CompletableFuture<java.lang.Void>	leave(Member localMember) 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

getMembers

java.util.Set<Member> getMembers()

Returns the set of current cluster members.

Returns:

set of cluster members

getMember

Member getMember(MemberId memberId)

Returns the specified member.

Parameters:

memberId - the member identifier

Returns:

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

join

java.util.concurrent.CompletableFuture<java.lang.Void> join(BootstrapService bootstrap,
                                                            NodeDiscoveryService discovery,
                                                            Member localMember)

Joins the cluster.

Parameters:

bootstrap - the bootstrap service

discovery - the discovery service

localMember - the local member info

Returns:

a future to be completed once the join is complete

leave

java.util.concurrent.CompletableFuture<java.lang.Void> leave(Member localMember)

Leaves the cluster.

Parameters:

localMember - the local member info

Returns:

a future to be completed once the leave is complete