RaftNodeImpl (Hazelcast Root 3.12-BETA-1 API)

java.lang.Object
- com.hazelcast.cp.internal.raft.impl.RaftNodeImpl

All Implemented Interfaces:: RaftNode

public class RaftNodeImpl
extends Object
implements RaftNode

Implementation of RaftNode.

Constructor Summary

Constructors
Constructor and Description
`RaftNodeImpl(CPGroupId groupId, Endpoint localMember, Collection<Endpoint> members, RaftAlgorithmConfig raftAlgorithmConfig, RaftIntegration raftIntegration)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyLogEntries()` Applies committed log entries between `lastApplied` and `commitIndex`, if there's any available.
`void`	`broadcastAppendRequest()` Broadcasts append-entries request to all group members according to their nextIndex parameters.
`boolean`	`canReplicateNewEntry(Object operation)` Returns true if a new entry with the operation is allowed to be replicated.
`void`	`completeFuture(long entryIndex, Object response)` Completes the future registered with `entryIndex`.
`void`	`execute(Runnable task)` Executes task using `RaftIntegration.execute(Runnable)`.
`void`	`forceSetTerminatedStatus()` Sets node's status to `RaftNodeStatus.TERMINATED` unconditionally if it's not terminated or stepped down yet.
`Object`	`getAppendedEntryOnLeaderElection()` Returns the entry to be appended if the no-op entry append on leader election feature is enabled.
`Collection<Endpoint>`	`getCommittedMembers()` Returns the last committed member list of the raft group this node belongs to.
`CPGroupId`	`getGroupId()` Returns the groupId which this node belongs to.
`Collection<Endpoint>`	`getInitialMembers()` Returns the initial member list of the Raft group this node belongs to.
`Endpoint`	`getLeader()` Returns the known leader endpoint.
`long`	`getLeaderElectionTimeoutInMillis()` Returns a randomized leader election timeout in milliseconds based on configured timeout.
`Endpoint`	`getLocalMember()` Returns the Raft endpoint for this node.
`ILogger`	`getLogger(Class clazz)`
`RaftNodeStatus`	`getStatus()` Returns the current status of this node.
`void`	`handleAppendRequest(AppendRequest request)` Handles `AppendRequest` sent by leader.
`void`	`handleAppendResponse(AppendFailureResponse response)` Handles `AppendFailureResponse` for a previously sent append request by this node.
`void`	`handleAppendResponse(AppendSuccessResponse response)` Handles `AppendSuccessResponse` for a previously sent append request by this node.
`void`	`handleInstallSnapshot(InstallSnapshot request)` Handles `InstallSnapshot` sent by leader.
`void`	`handlePreVoteRequest(PreVoteRequest request)` Handles `PreVoteRequest` sent by another follower.
`void`	`handlePreVoteResponse(PreVoteResponse response)` Handles `PreVoteResponse` for a previously sent request by this node.
`void`	`handleVoteRequest(VoteRequest request)` Handles `VoteRequest` sent by a candidate.
`void`	`handleVoteResponse(VoteResponse response)` Handles `VoteResponse` for a previously sent vote request by this node.
`boolean`	`installSnapshot(SnapshotEntry snapshot)` Restores the snapshot sent by the leader if it's not applied before.
`void`	`invalidateFuturesFrom(long entryIndex)` Invalidates futures registered with indexes `>= entryIndex`.
`boolean`	`isTerminatedOrSteppedDown()` Returns true if this node is `RaftNodeStatus.TERMINATED` or `RaftNodeStatus.STEPPED_DOWN`, false otherwise.
`long`	`lastAppendEntriesTimestamp()`
`void`	`printMemberState()`
`ICompletableFuture`	`query(Object operation, QueryPolicy queryPolicy)` Executes the given operation on Raft group depending on the `QueryPolicy`
`void`	`registerFuture(long entryIndex, SimpleCompletableFuture future)` Registers the future for the appended entry with its `entryIndex`.
`ICompletableFuture`	`replicate(Object operation)` Replicates the given operation to the Raft group.
`ICompletableFuture`	`replicateMembershipChange(Endpoint member, MembershipChangeMode mode)` Replicates the membership change to the Raft group.
`ICompletableFuture`	`replicateMembershipChange(Endpoint member, MembershipChangeMode mode, long groupMembersCommitIndex)` Replicates the membership change to the Raft group, if expected members commit index is equal to the actual one stored in Raft state.
`void`	`resetGroupMembers()` Resets Raft group members back.
`void`	`runQueryOperation(Object operation, SimpleCompletableFuture resultFuture)` Executes query operation sets execution result to the future.
`void`	`schedule(Runnable task, long delayInMillis)` Schedules task using `RaftIntegration.schedule(Runnable, long, TimeUnit)`.
`void`	`scheduleHeartbeat()` Schedules periodic heartbeat task when a new leader is elected.
`void`	`send(AppendFailureResponse response, Endpoint target)`
`void`	`send(AppendRequest request, Endpoint target)`
`void`	`send(AppendSuccessResponse response, Endpoint target)`
`void`	`send(PreVoteRequest request, Endpoint target)`
`void`	`send(PreVoteResponse response, Endpoint target)`
`void`	`send(VoteRequest request, Endpoint target)`
`void`	`send(VoteResponse response, Endpoint target)`
`void`	`sendAppendRequest(Endpoint follower)` Sends an append-entries request to the follower member.
`void`	`setStatus(RaftNodeStatus newStatus)`
`void`	`start()` Starts the periodic tasks, such as voting, leader failure-detection, snapshot handling.
`RaftState`	`state()`
`void`	`updateGroupMembers(long logIndex, Collection<Endpoint> members)` Updates Raft group members.
`void`	`updateLastAppendEntriesTimestamp()`

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

- Constructor Detail
  - RaftNodeImpl
```
public RaftNodeImpl(CPGroupId groupId,
                    Endpoint localMember,
                    Collection<Endpoint> members,
                    RaftAlgorithmConfig raftAlgorithmConfig,
                    RaftIntegration raftIntegration)
```
- Method Detail
  - getLogger
```
public ILogger getLogger(Class clazz)
```
  - getGroupId
```
public CPGroupId getGroupId()
```
    Description copied from interface: RaftNode
    
    Returns the groupId which this node belongs to.
    
    Specified by:
    
    getGroupId in interface RaftNode
  - getLocalMember
```
public Endpoint getLocalMember()
```
    Description copied from interface: RaftNode
    
    Returns the Raft endpoint for this node.
    
    Specified by:
    
    getLocalMember in interface RaftNode
  - getLeader
```
public Endpoint getLeader()
```
    Description copied from interface: RaftNode
    
    Returns the known leader endpoint. Leader endpoint might be already changed when this method returns.
    
    Specified by:
    
    getLeader in interface RaftNode
  - getStatus
```
public RaftNodeStatus getStatus()
```
    Description copied from interface: RaftNode
    
    Returns the current status of this node.
    
    Specified by:
    
    getStatus in interface RaftNode
  - getInitialMembers
```
public Collection<Endpoint> getInitialMembers()
```
    Description copied from interface: RaftNode
    
    Returns the initial member list of the Raft group this node belongs to.
    
    Specified by:
    
    getInitialMembers in interface RaftNode
  - getCommittedMembers
```
public Collection<Endpoint> getCommittedMembers()
```
    Description copied from interface: RaftNode
    
    Returns the last committed member list of the raft group this node belongs to. Please note that the returned member list can be different from the current effective member list, if there is an ongoing membership change in the group.
    
    Specified by:
    
    getCommittedMembers in interface RaftNode
  - forceSetTerminatedStatus
```
public void forceSetTerminatedStatus()
```
    Description copied from interface: RaftNode
    
    Sets node's status to RaftNodeStatus.TERMINATED unconditionally if it's not terminated or stepped down yet.
    
    Specified by:
    
    forceSetTerminatedStatus in interface RaftNode
  - start
```
public void start()
```
    Starts the periodic tasks, such as voting, leader failure-detection, snapshot handling.
  - handlePreVoteRequest
```
public void handlePreVoteRequest(PreVoteRequest request)
```
    Description copied from interface: RaftNode
    
    Handles PreVoteRequest sent by another follower.
    
    Specified by:
    
    handlePreVoteRequest in interface RaftNode
  - handlePreVoteResponse
```
public void handlePreVoteResponse(PreVoteResponse response)
```
    Description copied from interface: RaftNode
    
    Handles PreVoteResponse for a previously sent request by this node.
    
    Specified by:
    
    handlePreVoteResponse in interface RaftNode
  - handleVoteRequest
```
public void handleVoteRequest(VoteRequest request)
```
    Description copied from interface: RaftNode
    
    Handles VoteRequest sent by a candidate.
    
    Specified by:
    
    handleVoteRequest in interface RaftNode
  - handleVoteResponse
```
public void handleVoteResponse(VoteResponse response)
```
    Description copied from interface: RaftNode
    
    Handles VoteResponse for a previously sent vote request by this node.
    
    Specified by:
    
    handleVoteResponse in interface RaftNode
  - handleAppendRequest
```
public void handleAppendRequest(AppendRequest request)
```
    Description copied from interface: RaftNode
    
    Handles AppendRequest sent by leader.
    
    Specified by:
    
    handleAppendRequest in interface RaftNode
  - handleAppendResponse
```
public void handleAppendResponse(AppendSuccessResponse response)
```
    Description copied from interface: RaftNode
    
    Handles AppendSuccessResponse for a previously sent append request by this node.
    
    Specified by:
    
    handleAppendResponse in interface RaftNode
  - handleAppendResponse
```
public void handleAppendResponse(AppendFailureResponse response)
```
    Description copied from interface: RaftNode
    
    Handles AppendFailureResponse for a previously sent append request by this node.
    
    Specified by:
    
    handleAppendResponse in interface RaftNode
  - handleInstallSnapshot
```
public void handleInstallSnapshot(InstallSnapshot request)
```
    Description copied from interface: RaftNode
    
    Handles InstallSnapshot sent by leader.
    
    Specified by:
    
    handleInstallSnapshot in interface RaftNode
  - replicate
```
public ICompletableFuture replicate(Object operation)
```
    Description copied from interface: RaftNode
    
    Replicates the given operation to the Raft group. Only the leader can process replicate requests.
    Otherwise, if this node is not leader, or the leader is demoted before committing the operation, the returned future is notified with a related exception.
    
    Specified by:
    
    replicate in interface RaftNode
    
    Parameters:
    
    operation - operation to replicate
    
    Returns:
    
    future to get notified about result of the replication
  - replicateMembershipChange
```
public ICompletableFuture replicateMembershipChange(Endpoint member,
                                                    MembershipChangeMode mode)
```
    Description copied from interface: RaftNode
    
    Replicates the membership change to the Raft group. Only the leader can process membership change requests.
    If this node is not leader, or the leader is demoted before committing the operation, or membership change is not committed for any reason, then the returned future is notified with a related exception.
    
    Specified by:
    
    replicateMembershipChange in interface RaftNode
    
    Parameters:
    
    member - member to add or remove
    
    mode - type of membership change
    
    Returns:
    
    future to get notified about result of the membership change
  - replicateMembershipChange
```
public ICompletableFuture replicateMembershipChange(Endpoint member,
                                                    MembershipChangeMode mode,
                                                    long groupMembersCommitIndex)
```
    Description copied from interface: RaftNode
    
    Replicates the membership change to the Raft group, if expected members commit index is equal to the actual one stored in Raft state. Otherwise, fails with MismatchingGroupMembersCommitIndexException.
    For more info see RaftNode.replicate(Object).
    
    Specified by:
    
    replicateMembershipChange in interface RaftNode
    
    Parameters:
    
    member - member to add or remove
    
    mode - type of membership change
    
    groupMembersCommitIndex - expected members commit index
    
    Returns:
    
    future to get notified about result of the membership change
  - query
```
public ICompletableFuture query(Object operation,
                                QueryPolicy queryPolicy)
```
    Description copied from interface: RaftNode
    
    Executes the given operation on Raft group depending on the QueryPolicy
    
    Specified by:
    
    query in interface RaftNode
    
    Parameters:
    
    operation - operation to query
    
    queryPolicy - query policy to decide where to execute operation
    
    Returns:
    
    future to get notified about result of the query
  - isTerminatedOrSteppedDown
```
public boolean isTerminatedOrSteppedDown()
```
    Description copied from interface: RaftNode
    Returns true if this node is RaftNodeStatus.TERMINATED or RaftNodeStatus.STEPPED_DOWN, false otherwise.
    This method is essentially same as;
```
 
     return status == TERMINATED || status == STEPPED_DOWN
 
 
```
    Specified by:
    
    isTerminatedOrSteppedDown in interface RaftNode
  - setStatus
```
public void setStatus(RaftNodeStatus newStatus)
```
  - getLeaderElectionTimeoutInMillis
```
public long getLeaderElectionTimeoutInMillis()
```
    Returns a randomized leader election timeout in milliseconds based on configured timeout.
    
    See Also:
    
    RaftAlgorithmConfig.getLeaderElectionTimeoutInMillis()
  - getAppendedEntryOnLeaderElection
```
public Object getAppendedEntryOnLeaderElection()
```
    Returns the entry to be appended if the no-op entry append on leader election feature is enabled.
  - canReplicateNewEntry
```
public boolean canReplicateNewEntry(Object operation)
```
    Returns true if a new entry with the operation is allowed to be replicated.
    Replication is not allowed, when;
    - Node is terminating, terminated or stepped down. See RaftNodeStatus.
    - Raft log contains max allowed uncommitted entry count. See RaftAlgorithmConfig.getUncommittedEntryCountToRejectNewAppends().
    - The operation is a RaftGroupCmd and there's an ongoing membership change in group.
    - The operation is a membership change operation and there's no committed entry in this term yet. See RaftIntegration.getAppendedEntryOnLeaderElection() ()}.
  - scheduleHeartbeat
```
public void scheduleHeartbeat()
```
    Schedules periodic heartbeat task when a new leader is elected.
  - send
```
public void send(PreVoteRequest request,
                 Endpoint target)
```
  - send
```
public void send(PreVoteResponse response,
                 Endpoint target)
```
  - send
```
public void send(VoteRequest request,
                 Endpoint target)
```
  - send
```
public void send(VoteResponse response,
                 Endpoint target)
```
  - send
```
public void send(AppendRequest request,
                 Endpoint target)
```
  - send
```
public void send(AppendSuccessResponse response,
                 Endpoint target)
```
  - send
```
public void send(AppendFailureResponse response,
                 Endpoint target)
```
  - broadcastAppendRequest
```
public void broadcastAppendRequest()
```
    Broadcasts append-entries request to all group members according to their nextIndex parameters.
  - sendAppendRequest
```
public void sendAppendRequest(Endpoint follower)
```
    Sends an append-entries request to the follower member.
    Log entries between follower's known nextIndex and latest appended entry index are sent in a batch. Batch size can be RaftAlgorithmConfig.getAppendRequestMaxEntryCount() at most.
    If follower's nextIndex is behind the latest snapshot index, then InstallSnapshot request is sent.
    If leader doesn't know follower's matchIndex (if matchIndex == 0), then an empty append-entries is sent to save bandwidth until leader learns the matchIndex of the follower.
    If log entries contains multiple membership change entries, then entries batch is split to send only a single membership change in single append-entries request.
  - applyLogEntries
```
public void applyLogEntries()
```
    Applies committed log entries between lastApplied and commitIndex, if there's any available. If new entries are applied, RaftState's lastApplied field is updated.
    
    See Also:
    
    RaftState.lastApplied(), RaftState.commitIndex()
  - updateLastAppendEntriesTimestamp
```
public void updateLastAppendEntriesTimestamp()
```
  - lastAppendEntriesTimestamp
```
public long lastAppendEntriesTimestamp()
```
  - state
```
public RaftState state()
```
  - runQueryOperation
```
public void runQueryOperation(Object operation,
                              SimpleCompletableFuture resultFuture)
```
    Executes query operation sets execution result to the future.
  - execute
```
public void execute(Runnable task)
```
    Executes task using RaftIntegration.execute(Runnable).
  - schedule
```
public void schedule(Runnable task,
                     long delayInMillis)
```
    Schedules task using RaftIntegration.schedule(Runnable, long, TimeUnit).
  - registerFuture
```
public void registerFuture(long entryIndex,
                           SimpleCompletableFuture future)
```
    Registers the future for the appended entry with its entryIndex.
  - completeFuture
```
public void completeFuture(long entryIndex,
                           Object response)
```
    Completes the future registered with entryIndex.
  - invalidateFuturesFrom
```
public void invalidateFuturesFrom(long entryIndex)
```
    Invalidates futures registered with indexes >= entryIndex. Note that entryIndex is inclusive. LeaderDemotedException is set a result to futures.
  - installSnapshot
```
public boolean installSnapshot(SnapshotEntry snapshot)
```
    Restores the snapshot sent by the leader if it's not applied before.
    
    Returns:
    
    true if snapshot is restores, false otherwise.
  - printMemberState
```
public void printMemberState()
```
  - updateGroupMembers
```
public void updateGroupMembers(long logIndex,
                               Collection<Endpoint> members)
```
    Updates Raft group members.
    
    See Also:
    
    RaftState.updateGroupMembers(long, Collection)
  - resetGroupMembers
```
public void resetGroupMembers()
```
    Resets Raft group members back.
    
    See Also:
    
    RaftState.resetGroupMembers()

Class RaftNodeImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RaftNodeImpl

Method Detail

getLogger

getGroupId

getLocalMember

getLeader

getStatus

getInitialMembers

getCommittedMembers

forceSetTerminatedStatus

start

handlePreVoteRequest

handlePreVoteResponse

handleVoteRequest

handleVoteResponse

handleAppendRequest

handleAppendResponse

handleAppendResponse

handleInstallSnapshot

replicate

replicateMembershipChange

replicateMembershipChange

query

isTerminatedOrSteppedDown

setStatus

getLeaderElectionTimeoutInMillis

getAppendedEntryOnLeaderElection

canReplicateNewEntry

scheduleHeartbeat

send

send

send

send

send

send

send

broadcastAppendRequest

sendAppendRequest

applyLogEntries

updateLastAppendEntriesTimestamp

lastAppendEntriesTimestamp

state

runQueryOperation

execute

schedule

registerFuture

completeFuture

invalidateFuturesFrom

installSnapshot

printMemberState

updateGroupMembers

resetGroupMembers