java.lang.Object
- io.microraft.RaftConfig

All Implemented Interfaces:

Serializable
```
public final class RaftConfig
extends Object
implements Serializable
```
Contains the configuration parameters for MicroRaft's implementation.
RaftConfig is an immutable configuration class. You can use a RaftConfigBuilder to build a RaftConfig object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class RaftConfig.RaftConfigBuilder
Builder for Raft config

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`DEFAULT_APPEND_ENTRIES_REQUEST_BATCH_SIZE`	The default value for `appendEntriesRequestBatchSize`.
`static int`	`DEFAULT_COMMIT_COUNT_TO_TAKE_SNAPSHOT`	The default value for `commitCountToTakeSnapshot`.
`static long`	`DEFAULT_LEADER_ELECTION_TIMEOUT_MILLIS`	The default value for `leaderElectionTimeoutMillis`.
`static long`	`DEFAULT_LEADER_HEARTBEAT_PERIOD_SECS`	The default value for `leaderHeartbeatPeriodSecs`.
`static long`	`DEFAULT_LEADER_HEARTBEAT_TIMEOUT_SECS`	The default value for `leaderHeartbeatTimeoutSecs`
`static int`	`DEFAULT_MAX_PENDING_LOG_ENTRY_COUNT`	The default value for `maxPendingLogEntryCount`.
`static RaftConfig`	`DEFAULT_RAFT_CONFIG`	The config object with default configuration.
`static int`	`DEFAULT_RAFT_NODE_REPORT_PUBLISH_PERIOD_SECS`	The default value for `raftNodeReportPublishPeriodSecs`.
`static boolean`	`DEFAULT_TRANSFER_SNAPSHOTS_FROM_FOLLOWERS_ENABLED`	The default value for `transferSnapshotsFromFollowersEnabled`

Constructor Summary

Constructors
Constructor	Description
`RaftConfig(long leaderElectionTimeoutMillis, long leaderHeartbeatPeriodSecs, long leaderHeartbeatTimeoutSecs, int appendEntriesRequestBatchSize, int commitCountToTakeSnapshot, int maxPendingLogEntryCount, boolean transferSnapshotsFromFollowersEnabled, int raftNodeReportPublishPeriodSecs)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getAppendEntriesRequestBatchSize()`
`int`	`getCommitCountToTakeSnapshot()`
`long`	`getLeaderElectionTimeoutMillis()`
`long`	`getLeaderHeartbeatPeriodSecs()`
`long`	`getLeaderHeartbeatTimeoutSecs()`
`int`	`getMaxPendingLogEntryCount()`
`int`	`getRaftNodeReportPublishPeriodSecs()`
`boolean`	`isTransferSnapshotsFromFollowersEnabled()`
`static RaftConfig.RaftConfigBuilder`	`newBuilder()`	Creates a new Raft config builder.
`String`	`toString()`

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

- Field Detail
  - DEFAULT_LEADER_ELECTION_TIMEOUT_MILLIS
```
public static final long DEFAULT_LEADER_ELECTION_TIMEOUT_MILLIS
```
    The default value for leaderElectionTimeoutMillis.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LEADER_HEARTBEAT_TIMEOUT_SECS
```
public static final long DEFAULT_LEADER_HEARTBEAT_TIMEOUT_SECS
```
    The default value for leaderHeartbeatTimeoutSecs
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LEADER_HEARTBEAT_PERIOD_SECS
```
public static final long DEFAULT_LEADER_HEARTBEAT_PERIOD_SECS
```
    The default value for leaderHeartbeatPeriodSecs.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_PENDING_LOG_ENTRY_COUNT
```
public static final int DEFAULT_MAX_PENDING_LOG_ENTRY_COUNT
```
    The default value for maxPendingLogEntryCount.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_APPEND_ENTRIES_REQUEST_BATCH_SIZE
```
public static final int DEFAULT_APPEND_ENTRIES_REQUEST_BATCH_SIZE
```
    The default value for appendEntriesRequestBatchSize.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COMMIT_COUNT_TO_TAKE_SNAPSHOT
```
public static final int DEFAULT_COMMIT_COUNT_TO_TAKE_SNAPSHOT
```
    The default value for commitCountToTakeSnapshot.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TRANSFER_SNAPSHOTS_FROM_FOLLOWERS_ENABLED
```
public static final boolean DEFAULT_TRANSFER_SNAPSHOTS_FROM_FOLLOWERS_ENABLED
```
    The default value for transferSnapshotsFromFollowersEnabled
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RAFT_NODE_REPORT_PUBLISH_PERIOD_SECS
```
public static final int DEFAULT_RAFT_NODE_REPORT_PUBLISH_PERIOD_SECS
```
    The default value for raftNodeReportPublishPeriodSecs.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RAFT_CONFIG
```
public static final RaftConfig DEFAULT_RAFT_CONFIG
```
    The config object with default configuration.
- Constructor Detail
  - RaftConfig
```
public RaftConfig(long leaderElectionTimeoutMillis,
                  long leaderHeartbeatPeriodSecs,
                  long leaderHeartbeatTimeoutSecs,
                  int appendEntriesRequestBatchSize,
                  int commitCountToTakeSnapshot,
                  int maxPendingLogEntryCount,
                  boolean transferSnapshotsFromFollowersEnabled,
                  int raftNodeReportPublishPeriodSecs)
```
- Method Detail
  - newBuilder
```
public static RaftConfig.RaftConfigBuilder newBuilder()
```
    Creates a new Raft config builder.
    
    Returns:
    
    the builder to populate the parameters for RaftConfig.
  - getLeaderElectionTimeoutMillis
```
public long getLeaderElectionTimeoutMillis()
```
    Returns:
    
    the leader election timeout in milliseconds
    
    See Also:
    
    leaderElectionTimeoutMillis
  - getLeaderHeartbeatTimeoutSecs
```
public long getLeaderHeartbeatTimeoutSecs()
```
    Returns:
    
    leader heartbeat timeout seconds
    
    See Also:
    
    leaderHeartbeatTimeoutSecs
  - getLeaderHeartbeatPeriodSecs
```
public long getLeaderHeartbeatPeriodSecs()
```
    Returns:
    
    the leader election heartbeat period in seconds
    
    See Also:
    
    leaderHeartbeatPeriodSecs
  - getMaxPendingLogEntryCount
```
public int getMaxPendingLogEntryCount()
```
    Returns:
    
    the max pending log entry count
    
    See Also:
    
    maxPendingLogEntryCount
  - getAppendEntriesRequestBatchSize
```
public int getAppendEntriesRequestBatchSize()
```
    Returns:
    
    the append entries request batch size
    
    See Also:
    
    appendEntriesRequestBatchSize
  - getCommitCountToTakeSnapshot
```
public int getCommitCountToTakeSnapshot()
```
    Returns:
    
    the commit count to take snapshot
    
    See Also:
    
    commitCountToTakeSnapshot
  - isTransferSnapshotsFromFollowersEnabled
```
public boolean isTransferSnapshotsFromFollowersEnabled()
```
    Returns:
    
    true if the transfer snapshots from followers enabled
    
    See Also:
    
    transferSnapshotsFromFollowersEnabled
  - getRaftNodeReportPublishPeriodSecs
```
public int getRaftNodeReportPublishPeriodSecs()
```
    Returns:
    
    the raft node report publish period in seconds
    
    See Also:
    
    raftNodeReportPublishPeriodSecs
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RaftConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LEADER_ELECTION_TIMEOUT_MILLIS

DEFAULT_LEADER_HEARTBEAT_TIMEOUT_SECS

DEFAULT_LEADER_HEARTBEAT_PERIOD_SECS

DEFAULT_MAX_PENDING_LOG_ENTRY_COUNT

DEFAULT_APPEND_ENTRIES_REQUEST_BATCH_SIZE

DEFAULT_COMMIT_COUNT_TO_TAKE_SNAPSHOT

DEFAULT_TRANSFER_SNAPSHOTS_FROM_FOLLOWERS_ENABLED

DEFAULT_RAFT_NODE_REPORT_PUBLISH_PERIOD_SECS

DEFAULT_RAFT_CONFIG

Constructor Detail

RaftConfig

Method Detail

newBuilder

getLeaderElectionTimeoutMillis

getLeaderHeartbeatTimeoutSecs

getLeaderHeartbeatPeriodSecs

getMaxPendingLogEntryCount

getAppendEntriesRequestBatchSize

getCommitCountToTakeSnapshot

isTransferSnapshotsFromFollowersEnabled

getRaftNodeReportPublishPeriodSecs

toString