RaftState (Hazelcast Root 3.12.13 API)

java.lang.Object
- com.hazelcast.cp.internal.raft.impl.state.RaftState

```
public class RaftState
extends Object
```
RaftState is the mutable state maintained by Raft state machine on every node in the group.

Constructor Summary

Constructors
Constructor and Description

RaftState(CPGroupId groupId, Endpoint localEndpoint, Collection<Endpoint> endpoints, int logCapacity)

Constructors
Constructor and Description
`RaftState(CPGroupId groupId, Endpoint localEndpoint, Collection<Endpoint> endpoints, int logCapacity)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CandidateState`	`candidateState()` Returns the candidate state
`void`	`commitGroupMembers()` Marks the last applied group members as committed.
`long`	`commitIndex()` Returns the index of highest log entry known to be committed
`void`	`commitIndex(long index)` Updates commit index
`RaftGroupMembers`	`committedGroupMembers()` Returns committed group members
`CPGroupId`	`groupId()`
`Collection<Endpoint>`	`initialMembers()`
`void`	`initPreCandidateState()` Initializes pre-candidate state for pre-voting and grant a vote for local endpoint
`boolean`	`isKnownMember(Endpoint endpoint)` Returns true if the endpoint is a member of the last applied group, false otherwise.
`long`	`lastApplied()` Returns the index of highest log entry applied to state machine
`void`	`lastApplied(long index)` Updates the last applied index
`RaftGroupMembers`	`lastGroupMembers()` Returns the last applied group members
`int`	`lastVoteTerm()` Returns the term when this note voted for endpoint `votedFor`
`Endpoint`	`leader()` Returns the known leader
`void`	`leader(Endpoint endpoint)` Updates the known leader
`LeaderState`	`leaderState()` Returns the leader state
`RaftLog`	`log()` Returns the Raft log
`int`	`majority()` Returns majority number of the last applied group members
`int`	`memberCount()` Returns number of members in the last applied group members
`Collection<Endpoint>`	`members()` Returns all members in the last applied group members
`long`	`membersLogIndex()` Returns log index of the last applied group members
`String`	`name()`
`void`	`persistVote(int term, Endpoint endpoint)` Persist a vote for the endpoint in current term during leader election.
`CandidateState`	`preCandidateState()` Returns pre-candidate state
`Collection<Endpoint>`	`remoteMembers()` Returns remote members in the last applied group members
`void`	`removePreCandidateState()` Removes pre-candidate state
`void`	`resetGroupMembers()` Resets `lastGroupMembers` back to `committedGroupMembers`.
`void`	`restoreGroupMembers(long logIndex, Collection<Endpoint> members)` Restores group members from the snapshot.
`RaftRole`	`role()` Returns role of this node in the group.
`int`	`term()` Returns the latest term this node has seen
`VoteRequest`	`toCandidate()` Switches this node to candidate role.
`void`	`toFollower(int term)` Switches this node to follower role.
`void`	`toLeader()` Switches this node to leader role.
`void`	`updateGroupMembers(long logIndex, Collection<Endpoint> members)` Initializes the last applied group members with the members and logIndex.
`Endpoint`	`votedFor()` Returns the endpoint this note voted for

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RaftState
```
public RaftState(CPGroupId groupId,
                 Endpoint localEndpoint,
                 Collection<Endpoint> endpoints,
                 int logCapacity)
```
- Method Detail
  - name
```
public String name()
```
  - groupId
```
public CPGroupId groupId()
```
  - initialMembers
```
public Collection<Endpoint> initialMembers()
```
  - members
```
public Collection<Endpoint> members()
```
    Returns all members in the last applied group members
  - remoteMembers
```
public Collection<Endpoint> remoteMembers()
```
    Returns remote members in the last applied group members
  - memberCount
```
public int memberCount()
```
    Returns number of members in the last applied group members
  - majority
```
public int majority()
```
    Returns majority number of the last applied group members
  - membersLogIndex
```
public long membersLogIndex()
```
    Returns log index of the last applied group members
  - committedGroupMembers
```
public RaftGroupMembers committedGroupMembers()
```
    Returns committed group members
  - lastGroupMembers
```
public RaftGroupMembers lastGroupMembers()
```
    Returns the last applied group members
  - role
```
public RaftRole role()
```
    Returns role of this node in the group.
  - term
```
public int term()
```
    Returns the latest term this node has seen
  - leader
```
public Endpoint leader()
```
    Returns the known leader
  - lastVoteTerm
```
public int lastVoteTerm()
```
    Returns the term when this note voted for endpoint votedFor
    
    See Also:
    
    lastVoteTerm
  - votedFor
```
public Endpoint votedFor()
```
    Returns the endpoint this note voted for
    
    See Also:
    
    votedFor
  - leader
```
public void leader(Endpoint endpoint)
```
    Updates the known leader
  - commitIndex
```
public long commitIndex()
```
    Returns the index of highest log entry known to be committed
    
    See Also:
    
    commitIndex
  - commitIndex
```
public void commitIndex(long index)
```
    Updates commit index
    
    See Also:
    
    commitIndex
  - lastApplied
```
public long lastApplied()
```
    Returns the index of highest log entry applied to state machine
    
    See Also:
    
    lastApplied
  - lastApplied
```
public void lastApplied(long index)
```
    Updates the last applied index
    
    See Also:
    
    lastApplied
  - log
```
public RaftLog log()
```
    Returns the Raft log
  - leaderState
```
public LeaderState leaderState()
```
    Returns the leader state
  - candidateState
```
public CandidateState candidateState()
```
    Returns the candidate state
  - persistVote
```
public void persistVote(int term,
                        Endpoint endpoint)
```
    Persist a vote for the endpoint in current term during leader election.
  - toFollower
```
public void toFollower(int term)
```
    Switches this node to follower role. Clears leader and (pre)candidate states, updates the term.
    
    Parameters:
    
    term - current term
  - toCandidate
```
public VoteRequest toCandidate()
```
    Switches this node to candidate role. Clears pre-candidate and leader states. Initializes candidate state for current majority and grants vote for local endpoint as a candidate.
    
    Returns:
    
    vote request to sent to other members during leader election
  - toLeader
```
public void toLeader()
```
    Switches this node to leader role. Sets local endpoint as current leader. Clears (pre)candidate states. Initializes leader state for current members.
  - isKnownMember
```
public boolean isKnownMember(Endpoint endpoint)
```
    Returns true if the endpoint is a member of the last applied group, false otherwise.
  - initPreCandidateState
```
public void initPreCandidateState()
```
    Initializes pre-candidate state for pre-voting and grant a vote for local endpoint
  - removePreCandidateState
```
public void removePreCandidateState()
```
    Removes pre-candidate state
  - preCandidateState
```
public CandidateState preCandidateState()
```
    Returns pre-candidate state
  - updateGroupMembers
```
public void updateGroupMembers(long logIndex,
                               Collection<Endpoint> members)
```
    Initializes the last applied group members with the members and logIndex. This method expects there's no uncommitted membership changes, committed members are the same as the last applied members. Leader state is updated for the members which don't exist in committed members and committed members those don't exist in latest applied members are removed.
    
    Parameters:
    
    logIndex - log index of membership change
    
    members - latest applied members
  - commitGroupMembers
```
public void commitGroupMembers()
```
    Marks the last applied group members as committed. At this point committedGroupMembers and lastGroupMembers are the same.
  - resetGroupMembers
```
public void resetGroupMembers()
```
    Resets lastGroupMembers back to committedGroupMembers. Essentially this means, applied but uncommitted membership changes are reverted.
  - restoreGroupMembers
```
public void restoreGroupMembers(long logIndex,
                                Collection<Endpoint> members)
```
    Restores group members from the snapshot. Both committedGroupMembers and lastGroupMembers are overwritten and they become the same.

Class RaftState

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RaftState

Method Detail

name

groupId

initialMembers

members

remoteMembers

memberCount

majority

membersLogIndex

committedGroupMembers

lastGroupMembers

role

term

leader

lastVoteTerm

votedFor

leader

commitIndex

commitIndex

lastApplied

lastApplied

log

leaderState

candidateState

persistVote

toFollower

toCandidate

toLeader

isKnownMember

initPreCandidateState

removePreCandidateState

preCandidateState

updateGroupMembers

commitGroupMembers

resetGroupMembers

restoreGroupMembers