io.atomix.protocols.raft.proxy

Enum RaftProxy.State

java.lang.Object

java.lang.Enum<RaftProxy.State>

io.atomix.protocols.raft.proxy.RaftProxy.State

All Implemented Interfaces:

Serializable, Comparable<RaftProxy.State>

Enclosing interface:

RaftProxy

public static enum RaftProxy.State
extends Enum<RaftProxy.State>

Indicates the state of the client's communication with the Raft cluster.

Throughout the lifetime of a client, the client will transition through various states according to its ability to communicate with the cluster within the context of a RaftProxy. In some cases, client state changes may be indicative of a loss of guarantees. Users of the client should watch the state of the client to determine when guarantees are lost and react to changes in the client's ability to communicate with the cluster.

   
   client.onStateChange(state -> {
     switch (state) {
       case CONNECTED:
         // The client is healthy
         break;
       case SUSPENDED:
         // The client cannot connect to the cluster and operations may be unsafe
         break;
       case CLOSED:
         // The client has been closed and pending operations have failed
         break;
     }
   });
   
 

So long as the client is in the CONNECTED state, all guarantees with respect to reads and writes will be maintained, and a loss of the CONNECTED state may indicate a loss of linearizability. See the specific states for more info.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED Indicates that the client is closed.
CONNECTED Indicates that the client is connected and its session is open.
SUSPENDED Indicates that the client is suspended and its session may or may not be expired.

Method Summary

Modifier and Type	Method and Description
static RaftProxy.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static RaftProxy.State[]	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

CONNECTED

public static final RaftProxy.State CONNECTED

Indicates that the client is connected and its session is open.

SUSPENDED

public static final RaftProxy.State SUSPENDED

Indicates that the client is suspended and its session may or may not be expired.

CLOSED

public static final RaftProxy.State CLOSED

Indicates that the client is closed.

Method Detail

values

public static RaftProxy.State[] 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 (RaftProxy.State c : RaftProxy.State.values())
    System.out.println(c);

Returns:

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

valueOf

public static RaftProxy.State 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