io.atomix.copycat.server.cluster

Enum Member.Status

java.lang.Object

java.lang.Enum<Member.Status>

io.atomix.copycat.server.cluster.Member.Status

All Implemented Interfaces:

Serializable, Comparable<Member.Status>

Enclosing interface:

Member

public static enum Member.Status
extends Enum<Member.Status>

Indicates the availability of a member from the perspective of the cluster leader.

Member statuses are manged by the cluster leader. For each Member of a Cluster, the leader periodically sends a heartbeat to the member to determine its availability. In the event that the leader cannot contact a member for more than a few heartbeats, the leader will set the member's availability status to UNAVAILABLE. Once the leader reestablishes communication with the member, it will reset its status back to AVAILABLE.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVAILABLE Indicates that a member is reachable by the leader.
UNAVAILABLE Indicates that a member is unreachable by the leader.

Method Summary

Modifier and Type	Method and Description
static Member.Status	valueOf(String name) Returns the enum constant of this type with the specified name.
static Member.Status[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AVAILABLE

public static final Member.Status AVAILABLE

Indicates that a member is reachable by the leader.

Availability is determined by the leader's ability to successfully send heartbeats to the member. If the last heartbeat attempt to the member was successful, its status will be available. For members whose status is UNAVAILABLE, once the leader is able to heartbeat the member its status will be reset to available.

UNAVAILABLE

public static final Member.Status UNAVAILABLE

Indicates that a member is unreachable by the leader.

Availability is determined by the leader's ability to successfully send heartbeats to the member. If the leader repeatedly fails to heartbeat a member, the leader will eventually commit a configuration change setting the member's status to unavailable. Once the leader is able to contact the member again, its status will be reset to AVAILABLE.

Method Detail

values

public static Member.Status[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Member.Status c : Member.Status.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Member.Status valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null