Package io.atomix.cluster

Interface ClusterMembershipService

All Superinterfaces:
io.atomix.utils.event.ListenerService<ClusterMembershipEvent,​ClusterMembershipEventListener>
All Known Subinterfaces:
ManagedClusterMembershipService
public interface ClusterMembershipService
extends io.atomix.utils.event.ListenerService<ClusterMembershipEvent,​ClusterMembershipEventListener>
Service for obtaining information about the individual members within the cluster.

  • Method Summary

    Modifier and Type Method Description
    Member getLocalMember()
    Returns the local member.
    Member getMember​(MemberId memberId)
    Returns the specified member.
    default Member getMember​(io.atomix.utils.net.Address address)
    Returns a member by address.
    default Member getMember​(String memberId)
    Returns the specified member node.
    Set<Member> getMembers()
    Returns the set of current cluster members.
    default Set<Member> getReachableMembers()
    Returns the set of active reachable members.

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

    addListener, removeListener

  • Method Details

    • getLocalMember

      Member getLocalMember()
      Returns the local member.
      Returns:
      local member

    • getMembers

      Set<Member> getMembers()
      Returns the set of current cluster members.
      Returns:
      set of cluster members

    • getReachableMembers

      default Set<Member> getReachableMembers()
      Returns the set of active reachable members.
      Returns:
      the set of active reachable members

    • getMember

      default Member getMember​(String memberId)
      Returns the specified member node.

      This is a convenience method that wraps the given String in a MemberId. To avoid unnecessary object allocation, repeated invocations of this method should instead use getMember(MemberId).

      Parameters:
      memberId - the member identifier
      Returns:
      the member or null if no node with the given identifier exists

    • 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

    • getMember

      default Member getMember​(io.atomix.utils.net.Address address)
      Returns a member by address.
      Parameters:
      address - the member address
      Returns:
      the member or null if no member with the given address could be found