Package io.atomix.cluster.impl

Class DiscoveryMembershipProtocol

java.lang.Object

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

io.atomix.cluster.impl.DiscoveryMembershipProtocol

All Implemented Interfaces:

NodeDiscoveryEventListener, GroupMembershipProtocol, Configured<GroupMembershipProtocolConfig>, EventFilter<NodeDiscoveryEvent>, EventListener<NodeDiscoveryEvent>, ListenerService<GroupMembershipEvent,GroupMembershipEventListener>

public final class DiscoveryMembershipProtocol
extends AbstractListenerManager<GroupMembershipEvent,GroupMembershipEventListener>
implements GroupMembershipProtocol, NodeDiscoveryEventListener

A GroupMembershipProtocol implementation which uses the node discovery service to add and remove new members. Members can be either initially provided as is, or will be added/removed as nodes are added/removed in the associated NodeDiscoveryService passed during join(BootstrapService, NodeDiscoveryService, Member).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DiscoveryMembershipProtocol.Config

Field Summary

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

listenerRegistry

Constructor Summary

Constructors

Constructor	Description
DiscoveryMembershipProtocol()
DiscoveryMembershipProtocol(DiscoveryMembershipProtocol.Config config)
DiscoveryMembershipProtocol(Map<MemberId,Member> members)

Method Summary

Modifier and Type	Method	Description
GroupMembershipProtocolConfig	config()
void	event(NodeDiscoveryEvent event)
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 localMember)	Joins the cluster.
CompletableFuture<Void>	leave(Member localMember)	Leaves the cluster.

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

addListener, post, removeListener

Methods inherited from class java.lang.Object

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

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

isRelevant

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

addListener, removeListener

Constructor Details

DiscoveryMembershipProtocol

public DiscoveryMembershipProtocol()

DiscoveryMembershipProtocol

public DiscoveryMembershipProtocol(DiscoveryMembershipProtocol.Config config)

DiscoveryMembershipProtocol

public DiscoveryMembershipProtocol(Map<MemberId,Member> members)

Method Details

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 localMember)

Description copied from interface: GroupMembershipProtocol

Joins the cluster.

Specified by:

join in interface GroupMembershipProtocol

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

public CompletableFuture<Void> leave(Member localMember)

Description copied from interface: GroupMembershipProtocol

Leaves the cluster.

Specified by:

leave in interface GroupMembershipProtocol

Parameters:

localMember - the local member info

Returns:

a future to be completed once the leave is complete

event

public void event(NodeDiscoveryEvent event)

Specified by:

event in interface EventListener<NodeDiscoveryEvent>

config

public GroupMembershipProtocolConfig config()

Specified by:

config in interface Configured<GroupMembershipProtocolConfig>