com.hazelcast.cp.internal.raft.impl

Enum RaftRole

java.lang.Object

java.lang.Enum<RaftRole>

com.hazelcast.cp.internal.raft.impl.RaftRole

All Implemented Interfaces:

Serializable, Comparable<RaftRole>

public enum RaftRole
extends Enum<RaftRole>

Represents role of a member in a Raft group.

At any given time each member is in one of three roles: LEADER, FOLLOWER, or CANDIDATE.

Normally, there is exactly one leader and all of the other members are followers. But during leader election some of the followers can become candidates.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANDIDATE Candidate is used to elect a new leader.
FOLLOWER Followers are passive, they issue no requests on their own but simply respond to requests from leaders and candidates.
LEADER The leader handles all client requests (append entry, membership change, etc.) and replicates them to followers.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FOLLOWER

public static final RaftRole FOLLOWER

Followers are passive, they issue no requests on their own but simply respond to requests from leaders and candidates.

CANDIDATE

public static final RaftRole CANDIDATE

Candidate is used to elect a new leader. When a candidate wins votes of majority, it becomes the leader. Otherwise it becomes follower or candidate again.

LEADER

public static final RaftRole LEADER

The leader handles all client requests (append entry, membership change, etc.) and replicates them to followers.

Method Detail

values

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

Returns:

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

valueOf

public static RaftRole 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