ConsensusModule.Configuration (Aeron Message Transport)

java.lang.Object
- io.aeron.cluster.ConsensusModule.Configuration

Enclosing class:: ConsensusModule

public static class ConsensusModule.Configuration
extends Object

Configuration options for cluster.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`APPOINTED_LEADER_ID_DEFAULT` Default property for the appointed cluster leader id.
`static String`	`APPOINTED_LEADER_ID_PROP_NAME` Property name for the identity of the appointed leader.
`static String`	`AUTHENTICATOR_SUPPLIER_DEFAULT` Name of the class to use as a supplier of `Authenticator` for the cluster.
`static String`	`AUTHENTICATOR_SUPPLIER_PROP_NAME` Name of class to use as a supplier of `Authenticator` for the cluster.
`static int`	`CLUSTER_CLIENT_TIMEOUT_COUNT_TYPE_ID` Counter type id for the number of cluster clients which have been timed out.
`static int`	`CLUSTER_INGRESS_FRAGMENT_LIMIT_DEFAULT` Default for the limit for fragments to be consumed on each poll of ingress.
`static String`	`CLUSTER_INGRESS_FRAGMENT_LIMIT_PROP_NAME` Property name for the limit for fragments to be consumed on each poll of ingress.
`static int`	`CLUSTER_INVALID_REQUEST_COUNT_TYPE_ID` Counter type id for the number of invalid requests which the cluster has received.
`static int`	`CLUSTER_MEMBER_ID_DEFAULT` Default property for the cluster member identity.
`static String`	`CLUSTER_MEMBER_ID_PROP_NAME` Property name for the identity of the cluster member.
`static String`	`CLUSTER_MEMBERS_DEFAULT` Default property for the list of cluster member endpoints.
`static String`	`CLUSTER_MEMBERS_IGNORE_SNAPSHOT_DEFAULT` Default property for whether cluster member information in snapshots should be ignored or not.
`static String`	`CLUSTER_MEMBERS_IGNORE_SNAPSHOT_PROP_NAME` Property name for whether cluster member information in snapshots should be ignored on load or not.
`static String`	`CLUSTER_MEMBERS_PROP_NAME` Property name for the comma separated list of cluster member endpoints.
`static String`	`CLUSTER_MEMBERS_STATUS_ENDPOINTS_DEFAULT` Default property for the list of cluster member status endpoints.
`static String`	`CLUSTER_MEMBERS_STATUS_ENDPOINTS_PROP_NAME` Property name for the comma separated list of cluster member status endpoints used for adding passive followers as well as dynamic join of a cluster.
`static int`	`CLUSTER_NODE_ROLE_TYPE_ID` Counter type id for the cluster node role.
`static int`	`COMMIT_POSITION_TYPE_ID` Type id of a commit position counter.
`static int`	`CONSENSUS_MODULE_ERROR_COUNT_TYPE_ID` Counter type id for the consensus module error count.
`static int`	`CONSENSUS_MODULE_STATE_TYPE_ID` Counter type id for the consensus module state.
`static int`	`CONTROL_TOGGLE_TYPE_ID` Counter type id for the control toggle.
`static long`	`DYNAMIC_JOIN_INTERVAL_DEFAULT_NS` Default interval at which a dynamic joining member will send add cluster member and snapshot recording queries.
`static String`	`DYNAMIC_JOIN_INTERVAL_PROP_NAME` Interval at which a dynamic joining member will send add cluster member and snapshot recording queries.
`static int`	`ELECTION_STATE_TYPE_ID` Type id for election state counter.
`static long`	`ELECTION_STATUS_INTERVAL_DEFAULT_NS` Default interval at which a member will send out status updates during election phases.
`static String`	`ELECTION_STATUS_INTERVAL_PROP_NAME` Interval at which a member will send out status updates during election phases.
`static long`	`ELECTION_TIMEOUT_DEFAULT_NS` Default timeout after which an election fails if the candidate does not get a majority of votes.
`static String`	`ELECTION_TIMEOUT_PROP_NAME` Timeout after which an election fails if the candidate does not get a majority of votes.
`static int`	`ERROR_BUFFER_LENGTH_DEFAULT` Size in bytes of the error buffer for the cluster.
`static String`	`ERROR_BUFFER_LENGTH_PROP_NAME` Size in bytes of the error buffer for the cluster.
`static int`	`FILE_SYNC_LEVEL_DEFAULT` Default file sync level of normal writes.
`static String`	`FILE_SYNC_LEVEL_PROP_NAME` The level at which files should be sync'ed to disk.
`static long`	`LEADER_HEARTBEAT_INTERVAL_DEFAULT_NS` Interval at which a leader will send heartbeats if the log is not progressing.
`static String`	`LEADER_HEARTBEAT_INTERVAL_PROP_NAME` Interval at which a leader will send heartbeats if the log is not progressing.
`static long`	`LEADER_HEARTBEAT_TIMEOUT_DEFAULT_NS` Timeout for a leader if no heartbeat is received by an other member.
`static String`	`LEADER_HEARTBEAT_TIMEOUT_PROP_NAME` Timeout for a leader if no heartbeat is received by an other member.
`static String`	`LOG_CHANNEL_DEFAULT` Channel for the clustered log.
`static String`	`LOG_CHANNEL_PROP_NAME` Channel for the clustered log.
`static int`	`LOG_STREAM_ID_DEFAULT` Stream id within a channel for the clustered log.
`static String`	`LOG_STREAM_ID_PROP_NAME` Stream id within a channel for the clustered log.
`static int`	`MAX_CONCURRENT_SESSIONS_DEFAULT` Maximum number of cluster sessions that can be active concurrently.
`static String`	`MAX_CONCURRENT_SESSIONS_PROP_NAME` Maximum number of cluster sessions that can be active concurrently.
`static String`	`MEMBER_ENDPOINTS_DEFAULT` Default property for member endpoints.
`static String`	`MEMBER_ENDPOINTS_PROP_NAME` Property name for the comma separated list of member endpoints.
`static String`	`MEMBER_STATUS_CHANNEL_DEFAULT` Channel to be used for communicating cluster member status to each other.
`static String`	`MEMBER_STATUS_CHANNEL_PROP_NAME` Channel to be used communicating cluster member status to each other.
`static int`	`MEMBER_STATUS_STREAM_ID_DEFAULT` Stream id for the archived snapshots within a channel.
`static String`	`MEMBER_STATUS_STREAM_ID_PROP_NAME` Stream id within a channel for communicating cluster member status.
`static int`	`RECOVERY_STATE_TYPE_ID` Type id of a recovery state counter.
`static int`	`SERVICE_COUNT_DEFAULT` The number of services in this cluster instance.
`static String`	`SERVICE_COUNT_PROP_NAME` The number of services in this cluster instance.
`static int`	`SERVICE_ID` Service ID to identify a snapshot in the `RecordingLog`.
`static String`	`SESSION_INVALID_VERSION_MSG` Message detail to be sent when a session has an invalid client version.
`static String`	`SESSION_LIMIT_MSG` Message detail to be sent when max concurrent session limit is reached.
`static String`	`SESSION_REJECTED_MSG` Message detail to be sent when a session is rejected due to authentication.
`static long`	`SESSION_TIMEOUT_DEFAULT_NS` Timeout for a session if no activity is observed.
`static String`	`SESSION_TIMEOUT_PROP_NAME` Timeout for a session if no activity is observed.
`static String`	`SNAPSHOT_CHANNEL_DEFAULT` Channel to be used for archiving snapshots.
`static int`	`SNAPSHOT_COUNTER_TYPE_ID` Counter type id for count of snapshots taken.
`static int`	`SNAPSHOT_STREAM_ID_DEFAULT` Stream id for the archived snapshots within a channel.
`static long`	`SNAPSHOT_TYPE_ID` Type of snapshot for this component.
`static long`	`STARTUP_CANVASS_TIMEOUT_DEFAULT_NS` Default timeout after which an election vote will be attempted on startup when waiting to canvass the status of all members before going for a majority if possible.
`static String`	`STARTUP_CANVASS_TIMEOUT_PROP_NAME` Timeout after which an election vote will be attempted after startup while waiting to canvass the status of members if a majority has been heard from.
`static long`	`TERMINATION_TIMEOUT_DEFAULT_NS` Timeout waiting for follower termination by leader default value.
`static String`	`TERMINATION_TIMEOUT_PROP_NAME` Timeout waiting for follower termination by leader.
`static int`	`TICKS_PER_WHEEL_DEFAULT` Number of ticks, or spokes, on the timer wheel.
`static String`	`TICKS_PER_WHEEL_PROP_NAME` Number of ticks, or spokes, on the timer wheel.
`static long`	`WHEEL_TICK_RESOLUTION_DEFAULT_NS` Resolution in nanoseconds for each tick of the timer wheel for scheduling deadlines.
`static String`	`WHEEL_TICK_RESOLUTION_PROP_NAME` Resolution in nanoseconds for each tick of the timer wheel for scheduling deadlines.

Constructor Summary

Constructors
Constructor and Description

Configuration()

Constructors
Constructor and Description
`Configuration()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`appointedLeaderId()` The value `APPOINTED_LEADER_ID_DEFAULT` or system property `APPOINTED_LEADER_ID_PROP_NAME` if set.
`static AuthenticatorSupplier`	`authenticatorSupplier()` The value `AUTHENTICATOR_SUPPLIER_DEFAULT` or system property `AUTHENTICATOR_SUPPLIER_PROP_NAME` if set.
`static int`	`clusterMemberId()` The value `CLUSTER_MEMBER_ID_DEFAULT` or system property `CLUSTER_MEMBER_ID_PROP_NAME` if set.
`static String`	`clusterMembers()` The value `CLUSTER_MEMBERS_DEFAULT` or system property `CLUSTER_MEMBERS_PROP_NAME` if set.
`static boolean`	`clusterMembersIgnoreSnapshot()` The value `CLUSTER_MEMBERS_IGNORE_SNAPSHOT_DEFAULT` or system property `CLUSTER_MEMBERS_IGNORE_SNAPSHOT_PROP_NAME` if set.
`static String`	`clusterMembersStatusEndpoints()` The value `CLUSTER_MEMBERS_STATUS_ENDPOINTS_DEFAULT` or system property `CLUSTER_MEMBERS_STATUS_ENDPOINTS_PROP_NAME` if set.
`static long`	`dynamicJoinIntervalNs()` Interval at which a dynamic joining member will send out add cluster members and snapshot recording queries.
`static long`	`electionStatusIntervalNs()` Interval at which a member will send out status messages during the election phases.
`static long`	`electionTimeoutNs()` Timeout waiting for votes to become leader in an election.
`static int`	`errorBufferLength()` Size in bytes of the error buffer in the mark file.
`static int`	`fileSyncLevel()` The level at which files should be sync'ed to disk.
`static int`	`ingressFragmentLimit()` The value `CLUSTER_INGRESS_FRAGMENT_LIMIT_DEFAULT` or system property `CLUSTER_INGRESS_FRAGMENT_LIMIT_PROP_NAME` if set.
`static long`	`leaderHeartbeatIntervalNs()` Interval at which a leader will send a heartbeat if the log is not progressing.
`static long`	`leaderHeartbeatTimeoutNs()` Timeout for a leader if no heartbeat is received by an other member.
`static String`	`logChannel()` The value `LOG_CHANNEL_DEFAULT` or system property `LOG_CHANNEL_PROP_NAME` if set.
`static int`	`logStreamId()` The value `LOG_STREAM_ID_DEFAULT` or system property `LOG_STREAM_ID_PROP_NAME` if set.
`static int`	`maxConcurrentSessions()` The value `MAX_CONCURRENT_SESSIONS_DEFAULT` or system property `MAX_CONCURRENT_SESSIONS_PROP_NAME` if set.
`static String`	`memberEndpoints()` The value `MEMBER_ENDPOINTS_DEFAULT` or system property `MEMBER_ENDPOINTS_PROP_NAME` if set.
`static String`	`memberStatusChannel()` The value `MEMBER_STATUS_CHANNEL_DEFAULT` or system property `MEMBER_STATUS_CHANNEL_PROP_NAME` if set.
`static int`	`memberStatusStreamId()` The value `MEMBER_STATUS_STREAM_ID_DEFAULT` or system property `MEMBER_STATUS_STREAM_ID_PROP_NAME` if set.
`static int`	`serviceCount()` The value `SERVICE_COUNT_DEFAULT` or system property `SERVICE_COUNT_PROP_NAME` if set.
`static long`	`sessionTimeoutNs()` Timeout for a session if no activity is observed.
`static String`	`snapshotChannel()` The value `SNAPSHOT_CHANNEL_DEFAULT` or system property `ClusteredServiceContainer.Configuration.SNAPSHOT_CHANNEL_PROP_NAME` if set.
`static int`	`snapshotStreamId()` The value `SNAPSHOT_STREAM_ID_DEFAULT` or system property `ClusteredServiceContainer.Configuration.SNAPSHOT_STREAM_ID_PROP_NAME` if set.
`static long`	`startupCanvassTimeoutNs()` Timeout waiting to canvass the status of cluster members before voting if a majority have been heard from.
`static long`	`terminationTimeoutNs()` Timeout waiting for follower termination by leader.
`static int`	`ticksPerWheel()` The value `TICKS_PER_WHEEL_DEFAULT` or system property `CLUSTER_MEMBER_ID_PROP_NAME` if set.
`static long`	`wheelTickResolutionNs()` The value `WHEEL_TICK_RESOLUTION_DEFAULT_NS` or system property `WHEEL_TICK_RESOLUTION_PROP_NAME` if set.

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

- Field Detail
  - CLUSTER_INGRESS_FRAGMENT_LIMIT_PROP_NAME
```
public static final String CLUSTER_INGRESS_FRAGMENT_LIMIT_PROP_NAME
```
    Property name for the limit for fragments to be consumed on each poll of ingress.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_INGRESS_FRAGMENT_LIMIT_DEFAULT
```
public static final int CLUSTER_INGRESS_FRAGMENT_LIMIT_DEFAULT
```
    Default for the limit for fragments to be consumed on each poll of ingress.
    
    See Also:
    
    Constant Field Values
  - SNAPSHOT_TYPE_ID
```
public static final long SNAPSHOT_TYPE_ID
```
    Type of snapshot for this component.
    
    See Also:
    
    Constant Field Values
  - SERVICE_ID
```
public static final int SERVICE_ID
```
    Service ID to identify a snapshot in the RecordingLog.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_MEMBER_ID_PROP_NAME
```
public static final String CLUSTER_MEMBER_ID_PROP_NAME
```
    Property name for the identity of the cluster member.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_MEMBER_ID_DEFAULT
```
public static final int CLUSTER_MEMBER_ID_DEFAULT
```
    Default property for the cluster member identity.
    
    See Also:
    
    Constant Field Values
  - APPOINTED_LEADER_ID_PROP_NAME
```
public static final String APPOINTED_LEADER_ID_PROP_NAME
```
    Property name for the identity of the appointed leader. This is when automated leader elections are not employed.
    
    See Also:
    
    Constant Field Values
  - APPOINTED_LEADER_ID_DEFAULT
```
public static final int APPOINTED_LEADER_ID_DEFAULT
```
    Default property for the appointed cluster leader id. A value of Aeron.NULL_VALUE means no leader has been appointed and thus an automated leader election should occur.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_MEMBERS_PROP_NAME
```
public static final String CLUSTER_MEMBERS_PROP_NAME
```
    Property name for the comma separated list of cluster member endpoints.
    0,client-facing:port,member-facing:port,log:port,transfer:port,archive:port| \ 1,client-facing:port,member-facing:port,log:port,transfer:port,archive:port| ...
    The client facing endpoints will be used as the endpoint substituted into the AeronCluster.Configuration.INGRESS_CHANNEL_PROP_NAME if the endpoint is not provided when unicast.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_MEMBERS_DEFAULT
```
public static final String CLUSTER_MEMBERS_DEFAULT
```
    Default property for the list of cluster member endpoints.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_MEMBERS_STATUS_ENDPOINTS_PROP_NAME
```
public static final String CLUSTER_MEMBERS_STATUS_ENDPOINTS_PROP_NAME
```
    Property name for the comma separated list of cluster member status endpoints used for adding passive followers as well as dynamic join of a cluster.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_MEMBERS_STATUS_ENDPOINTS_DEFAULT
```
public static final String CLUSTER_MEMBERS_STATUS_ENDPOINTS_DEFAULT
```
    Default property for the list of cluster member status endpoints.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_MEMBERS_IGNORE_SNAPSHOT_PROP_NAME
```
public static final String CLUSTER_MEMBERS_IGNORE_SNAPSHOT_PROP_NAME
```
    Property name for whether cluster member information in snapshots should be ignored on load or not.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_MEMBERS_IGNORE_SNAPSHOT_DEFAULT
```
public static final String CLUSTER_MEMBERS_IGNORE_SNAPSHOT_DEFAULT
```
    Default property for whether cluster member information in snapshots should be ignored or not.
    
    See Also:
    
    Constant Field Values
  - LOG_CHANNEL_PROP_NAME
```
public static final String LOG_CHANNEL_PROP_NAME
```
    Channel for the clustered log.
    
    See Also:
    
    Constant Field Values
  - LOG_CHANNEL_DEFAULT
```
public static final String LOG_CHANNEL_DEFAULT
```
    Channel for the clustered log. This channel can exist for a potentially log time given cluster operation so attention should be given to configuration such as term-length and mtu.
    
    See Also:
    
    Constant Field Values
  - MEMBER_ENDPOINTS_PROP_NAME
```
public static final String MEMBER_ENDPOINTS_PROP_NAME
```
    Property name for the comma separated list of member endpoints.
    client-facing:port,member-facing:port,log:port,transfer:port,archive:port
    
    See Also:
    
    CLUSTER_MEMBERS_PROP_NAME, Constant Field Values
  - MEMBER_ENDPOINTS_DEFAULT
```
public static final String MEMBER_ENDPOINTS_DEFAULT
```
    Default property for member endpoints.
    
    See Also:
    
    Constant Field Values
  - LOG_STREAM_ID_PROP_NAME
```
public static final String LOG_STREAM_ID_PROP_NAME
```
    Stream id within a channel for the clustered log.
    
    See Also:
    
    Constant Field Values
  - LOG_STREAM_ID_DEFAULT
```
public static final int LOG_STREAM_ID_DEFAULT
```
    Stream id within a channel for the clustered log.
    
    See Also:
    
    Constant Field Values
  - SNAPSHOT_CHANNEL_DEFAULT
```
public static final String SNAPSHOT_CHANNEL_DEFAULT
```
    Channel to be used for archiving snapshots.
    
    See Also:
    
    Constant Field Values
  - SNAPSHOT_STREAM_ID_DEFAULT
```
public static final int SNAPSHOT_STREAM_ID_DEFAULT
```
    Stream id for the archived snapshots within a channel.
    
    See Also:
    
    Constant Field Values
  - SESSION_LIMIT_MSG
```
public static final String SESSION_LIMIT_MSG
```
    Message detail to be sent when max concurrent session limit is reached.
    
    See Also:
    
    Constant Field Values
  - SESSION_REJECTED_MSG
```
public static final String SESSION_REJECTED_MSG
```
    Message detail to be sent when a session is rejected due to authentication.
    
    See Also:
    
    Constant Field Values
  - SESSION_INVALID_VERSION_MSG
```
public static final String SESSION_INVALID_VERSION_MSG
```
    Message detail to be sent when a session has an invalid client version.
    
    See Also:
    
    Constant Field Values
  - MEMBER_STATUS_CHANNEL_PROP_NAME
```
public static final String MEMBER_STATUS_CHANNEL_PROP_NAME
```
    Channel to be used communicating cluster member status to each other. This can be used for default configuration with the endpoints replaced with those provided by CLUSTER_MEMBERS_PROP_NAME.
    
    See Also:
    
    Constant Field Values
  - MEMBER_STATUS_CHANNEL_DEFAULT
```
public static final String MEMBER_STATUS_CHANNEL_DEFAULT
```
    Channel to be used for communicating cluster member status to each other. This can be used for default configuration with the endpoints replaced with those provided by CLUSTER_MEMBERS_PROP_NAME.
    
    See Also:
    
    Constant Field Values
  - MEMBER_STATUS_STREAM_ID_PROP_NAME
```
public static final String MEMBER_STATUS_STREAM_ID_PROP_NAME
```
    Stream id within a channel for communicating cluster member status.
    
    See Also:
    
    Constant Field Values
  - MEMBER_STATUS_STREAM_ID_DEFAULT
```
public static final int MEMBER_STATUS_STREAM_ID_DEFAULT
```
    Stream id for the archived snapshots within a channel.
    
    See Also:
    
    Constant Field Values
  - CONSENSUS_MODULE_STATE_TYPE_ID
```
public static final int CONSENSUS_MODULE_STATE_TYPE_ID
```
    Counter type id for the consensus module state.
    
    See Also:
    
    Constant Field Values
  - CONSENSUS_MODULE_ERROR_COUNT_TYPE_ID
```
public static final int CONSENSUS_MODULE_ERROR_COUNT_TYPE_ID
```
    Counter type id for the consensus module error count.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_CLIENT_TIMEOUT_COUNT_TYPE_ID
```
public static final int CLUSTER_CLIENT_TIMEOUT_COUNT_TYPE_ID
```
    Counter type id for the number of cluster clients which have been timed out.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_INVALID_REQUEST_COUNT_TYPE_ID
```
public static final int CLUSTER_INVALID_REQUEST_COUNT_TYPE_ID
```
    Counter type id for the number of invalid requests which the cluster has received.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_NODE_ROLE_TYPE_ID
```
public static final int CLUSTER_NODE_ROLE_TYPE_ID
```
    Counter type id for the cluster node role.
    
    See Also:
    
    Constant Field Values
  - CONTROL_TOGGLE_TYPE_ID
```
public static final int CONTROL_TOGGLE_TYPE_ID
```
    Counter type id for the control toggle.
    
    See Also:
    
    Constant Field Values
  - COMMIT_POSITION_TYPE_ID
```
public static final int COMMIT_POSITION_TYPE_ID
```
    Type id of a commit position counter.
    
    See Also:
    
    Constant Field Values
  - RECOVERY_STATE_TYPE_ID
```
public static final int RECOVERY_STATE_TYPE_ID
```
    Type id of a recovery state counter.
    
    See Also:
    
    Constant Field Values
  - SNAPSHOT_COUNTER_TYPE_ID
```
public static final int SNAPSHOT_COUNTER_TYPE_ID
```
    Counter type id for count of snapshots taken.
    
    See Also:
    
    Constant Field Values
  - ELECTION_STATE_TYPE_ID
```
public static final int ELECTION_STATE_TYPE_ID
```
    Type id for election state counter.
    
    See Also:
    
    Constant Field Values
  - SERVICE_COUNT_PROP_NAME
```
public static final String SERVICE_COUNT_PROP_NAME
```
    The number of services in this cluster instance.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.SERVICE_ID_PROP_NAME, Constant Field Values
  - SERVICE_COUNT_DEFAULT
```
public static final int SERVICE_COUNT_DEFAULT
```
    The number of services in this cluster instance.
    
    See Also:
    
    Constant Field Values
  - MAX_CONCURRENT_SESSIONS_PROP_NAME
```
public static final String MAX_CONCURRENT_SESSIONS_PROP_NAME
```
    Maximum number of cluster sessions that can be active concurrently.
    
    See Also:
    
    Constant Field Values
  - MAX_CONCURRENT_SESSIONS_DEFAULT
```
public static final int MAX_CONCURRENT_SESSIONS_DEFAULT
```
    Maximum number of cluster sessions that can be active concurrently.
    
    See Also:
    
    Constant Field Values
  - SESSION_TIMEOUT_PROP_NAME
```
public static final String SESSION_TIMEOUT_PROP_NAME
```
    Timeout for a session if no activity is observed.
    
    See Also:
    
    Constant Field Values
  - SESSION_TIMEOUT_DEFAULT_NS
```
public static final long SESSION_TIMEOUT_DEFAULT_NS
```
    Timeout for a session if no activity is observed.
  - LEADER_HEARTBEAT_TIMEOUT_PROP_NAME
```
public static final String LEADER_HEARTBEAT_TIMEOUT_PROP_NAME
```
    Timeout for a leader if no heartbeat is received by an other member.
    
    See Also:
    
    Constant Field Values
  - LEADER_HEARTBEAT_TIMEOUT_DEFAULT_NS
```
public static final long LEADER_HEARTBEAT_TIMEOUT_DEFAULT_NS
```
    Timeout for a leader if no heartbeat is received by an other member.
  - LEADER_HEARTBEAT_INTERVAL_PROP_NAME
```
public static final String LEADER_HEARTBEAT_INTERVAL_PROP_NAME
```
    Interval at which a leader will send heartbeats if the log is not progressing.
    
    See Also:
    
    Constant Field Values
  - LEADER_HEARTBEAT_INTERVAL_DEFAULT_NS
```
public static final long LEADER_HEARTBEAT_INTERVAL_DEFAULT_NS
```
    Interval at which a leader will send heartbeats if the log is not progressing.
  - STARTUP_CANVASS_TIMEOUT_PROP_NAME
```
public static final String STARTUP_CANVASS_TIMEOUT_PROP_NAME
```
    Timeout after which an election vote will be attempted after startup while waiting to canvass the status of members if a majority has been heard from.
    
    See Also:
    
    Constant Field Values
  - STARTUP_CANVASS_TIMEOUT_DEFAULT_NS
```
public static final long STARTUP_CANVASS_TIMEOUT_DEFAULT_NS
```
    Default timeout after which an election vote will be attempted on startup when waiting to canvass the status of all members before going for a majority if possible.
  - ELECTION_TIMEOUT_PROP_NAME
```
public static final String ELECTION_TIMEOUT_PROP_NAME
```
    Timeout after which an election fails if the candidate does not get a majority of votes.
    
    See Also:
    
    Constant Field Values
  - ELECTION_TIMEOUT_DEFAULT_NS
```
public static final long ELECTION_TIMEOUT_DEFAULT_NS
```
    Default timeout after which an election fails if the candidate does not get a majority of votes.
  - ELECTION_STATUS_INTERVAL_PROP_NAME
```
public static final String ELECTION_STATUS_INTERVAL_PROP_NAME
```
    Interval at which a member will send out status updates during election phases.
    
    See Also:
    
    Constant Field Values
  - ELECTION_STATUS_INTERVAL_DEFAULT_NS
```
public static final long ELECTION_STATUS_INTERVAL_DEFAULT_NS
```
    Default interval at which a member will send out status updates during election phases.
  - DYNAMIC_JOIN_INTERVAL_PROP_NAME
```
public static final String DYNAMIC_JOIN_INTERVAL_PROP_NAME
```
    Interval at which a dynamic joining member will send add cluster member and snapshot recording queries.
    
    See Also:
    
    Constant Field Values
  - DYNAMIC_JOIN_INTERVAL_DEFAULT_NS
```
public static final long DYNAMIC_JOIN_INTERVAL_DEFAULT_NS
```
    Default interval at which a dynamic joining member will send add cluster member and snapshot recording queries.
  - AUTHENTICATOR_SUPPLIER_PROP_NAME
```
public static final String AUTHENTICATOR_SUPPLIER_PROP_NAME
```
    Name of class to use as a supplier of Authenticator for the cluster.
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATOR_SUPPLIER_DEFAULT
```
public static final String AUTHENTICATOR_SUPPLIER_DEFAULT
```
    Name of the class to use as a supplier of Authenticator for the cluster. Default is a non-authenticating option.
    
    See Also:
    
    Constant Field Values
  - ERROR_BUFFER_LENGTH_PROP_NAME
```
public static final String ERROR_BUFFER_LENGTH_PROP_NAME
```
    Size in bytes of the error buffer for the cluster.
    
    See Also:
    
    Constant Field Values
  - ERROR_BUFFER_LENGTH_DEFAULT
```
public static final int ERROR_BUFFER_LENGTH_DEFAULT
```
    Size in bytes of the error buffer for the cluster.
    
    See Also:
    
    Constant Field Values
  - TERMINATION_TIMEOUT_PROP_NAME
```
public static final String TERMINATION_TIMEOUT_PROP_NAME
```
    Timeout waiting for follower termination by leader.
    
    See Also:
    
    Constant Field Values
  - TERMINATION_TIMEOUT_DEFAULT_NS
```
public static final long TERMINATION_TIMEOUT_DEFAULT_NS
```
    Timeout waiting for follower termination by leader default value.
  - WHEEL_TICK_RESOLUTION_PROP_NAME
```
public static final String WHEEL_TICK_RESOLUTION_PROP_NAME
```
    Resolution in nanoseconds for each tick of the timer wheel for scheduling deadlines.
    
    See Also:
    
    Constant Field Values
  - WHEEL_TICK_RESOLUTION_DEFAULT_NS
```
public static final long WHEEL_TICK_RESOLUTION_DEFAULT_NS
```
    Resolution in nanoseconds for each tick of the timer wheel for scheduling deadlines. Defaults to 8ms.
  - TICKS_PER_WHEEL_PROP_NAME
```
public static final String TICKS_PER_WHEEL_PROP_NAME
```
    Number of ticks, or spokes, on the timer wheel. Higher number of ticks reduces potential conflicts traded off against memory usage.
    
    See Also:
    
    Constant Field Values
  - TICKS_PER_WHEEL_DEFAULT
```
public static final int TICKS_PER_WHEEL_DEFAULT
```
    Number of ticks, or spokes, on the timer wheel. Higher number of ticks reduces potential conflicts traded off against memory usage. Defaults to 128 per wheel.
    
    See Also:
    
    Constant Field Values
  - FILE_SYNC_LEVEL_PROP_NAME
```
public static final String FILE_SYNC_LEVEL_PROP_NAME
```
    The level at which files should be sync'ed to disk.
    - 0 - normal writes.
    - 1 - sync file data.
    - 2 - sync file data + metadata.
    See Also:
    
    Constant Field Values
  - FILE_SYNC_LEVEL_DEFAULT
```
public static final int FILE_SYNC_LEVEL_DEFAULT
```
    Default file sync level of normal writes.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Configuration
```
public Configuration()
```
- Method Detail
  - ingressFragmentLimit
```
public static int ingressFragmentLimit()
```
    The value CLUSTER_INGRESS_FRAGMENT_LIMIT_DEFAULT or system property CLUSTER_INGRESS_FRAGMENT_LIMIT_PROP_NAME if set.
    
    Returns:
    
    CLUSTER_INGRESS_FRAGMENT_LIMIT_DEFAULT or system property CLUSTER_INGRESS_FRAGMENT_LIMIT_PROP_NAME if set.
  - clusterMemberId
```
public static int clusterMemberId()
```
    The value CLUSTER_MEMBER_ID_DEFAULT or system property CLUSTER_MEMBER_ID_PROP_NAME if set.
    
    Returns:
    
    CLUSTER_MEMBER_ID_DEFAULT or system property CLUSTER_MEMBER_ID_PROP_NAME if set.
  - appointedLeaderId
```
public static int appointedLeaderId()
```
    The value APPOINTED_LEADER_ID_DEFAULT or system property APPOINTED_LEADER_ID_PROP_NAME if set.
    
    Returns:
    
    APPOINTED_LEADER_ID_DEFAULT or system property APPOINTED_LEADER_ID_PROP_NAME if set.
  - clusterMembers
```
public static String clusterMembers()
```
    The value CLUSTER_MEMBERS_DEFAULT or system property CLUSTER_MEMBERS_PROP_NAME if set.
    
    Returns:
    
    CLUSTER_MEMBERS_DEFAULT or system property CLUSTER_MEMBERS_PROP_NAME if set.
  - clusterMembersStatusEndpoints
```
public static String clusterMembersStatusEndpoints()
```
    The value CLUSTER_MEMBERS_STATUS_ENDPOINTS_DEFAULT or system property CLUSTER_MEMBERS_STATUS_ENDPOINTS_PROP_NAME if set.
    
    Returns:
    
    CLUSTER_MEMBERS_STATUS_ENDPOINTS_DEFAULT or system property CLUSTER_MEMBERS_STATUS_ENDPOINTS_PROP_NAME it set.
  - clusterMembersIgnoreSnapshot
```
public static boolean clusterMembersIgnoreSnapshot()
```
    The value CLUSTER_MEMBERS_IGNORE_SNAPSHOT_DEFAULT or system property CLUSTER_MEMBERS_IGNORE_SNAPSHOT_PROP_NAME if set.
    
    Returns:
    
    CLUSTER_MEMBERS_IGNORE_SNAPSHOT_DEFAULT or system property CLUSTER_MEMBERS_IGNORE_SNAPSHOT_PROP_NAME it set.
  - logChannel
```
public static String logChannel()
```
    The value LOG_CHANNEL_DEFAULT or system property LOG_CHANNEL_PROP_NAME if set.
    
    Returns:
    
    LOG_CHANNEL_DEFAULT or system property LOG_CHANNEL_PROP_NAME if set.
  - logStreamId
```
public static int logStreamId()
```
    The value LOG_STREAM_ID_DEFAULT or system property LOG_STREAM_ID_PROP_NAME if set.
    
    Returns:
    
    LOG_STREAM_ID_DEFAULT or system property LOG_STREAM_ID_PROP_NAME if set.
  - memberEndpoints
```
public static String memberEndpoints()
```
    The value MEMBER_ENDPOINTS_DEFAULT or system property MEMBER_ENDPOINTS_PROP_NAME if set.
    
    Returns:
    
    MEMBER_ENDPOINTS_DEFAULT or system property MEMBER_ENDPOINTS_PROP_NAME if set.
  - snapshotChannel
```
public static String snapshotChannel()
```
    The value SNAPSHOT_CHANNEL_DEFAULT or system property ClusteredServiceContainer.Configuration.SNAPSHOT_CHANNEL_PROP_NAME if set.
    
    Returns:
    
    SNAPSHOT_CHANNEL_DEFAULT or system property ClusteredServiceContainer.Configuration.SNAPSHOT_CHANNEL_PROP_NAME if set.
  - snapshotStreamId
```
public static int snapshotStreamId()
```
    The value SNAPSHOT_STREAM_ID_DEFAULT or system property ClusteredServiceContainer.Configuration.SNAPSHOT_STREAM_ID_PROP_NAME if set.
    
    Returns:
    
    SNAPSHOT_STREAM_ID_DEFAULT or system property ClusteredServiceContainer.Configuration.SNAPSHOT_STREAM_ID_PROP_NAME if set.
  - serviceCount
```
public static int serviceCount()
```
    The value SERVICE_COUNT_DEFAULT or system property SERVICE_COUNT_PROP_NAME if set.
    
    Returns:
    
    SERVICE_COUNT_DEFAULT or system property SERVICE_COUNT_PROP_NAME if set.
  - maxConcurrentSessions
```
public static int maxConcurrentSessions()
```
    The value MAX_CONCURRENT_SESSIONS_DEFAULT or system property MAX_CONCURRENT_SESSIONS_PROP_NAME if set.
    
    Returns:
    
    MAX_CONCURRENT_SESSIONS_DEFAULT or system property MAX_CONCURRENT_SESSIONS_PROP_NAME if set.
  - sessionTimeoutNs
```
public static long sessionTimeoutNs()
```
    Timeout for a session if no activity is observed.
    
    Returns:
    
    timeout in nanoseconds to wait for activity
    
    See Also:
    
    SESSION_TIMEOUT_PROP_NAME
  - leaderHeartbeatTimeoutNs
```
public static long leaderHeartbeatTimeoutNs()
```
    Timeout for a leader if no heartbeat is received by an other member.
    
    Returns:
    
    timeout in nanoseconds to wait for heartbeat from a leader.
    
    See Also:
    
    LEADER_HEARTBEAT_TIMEOUT_PROP_NAME
  - leaderHeartbeatIntervalNs
```
public static long leaderHeartbeatIntervalNs()
```
    Interval at which a leader will send a heartbeat if the log is not progressing.
    
    Returns:
    
    timeout in nanoseconds to for leader heartbeats when no log being appended.
    
    See Also:
    
    LEADER_HEARTBEAT_INTERVAL_PROP_NAME
  - startupCanvassTimeoutNs
```
public static long startupCanvassTimeoutNs()
```
    Timeout waiting to canvass the status of cluster members before voting if a majority have been heard from.
    
    Returns:
    
    timeout in nanoseconds to wait for the status of other cluster members before voting.
    
    See Also:
    
    STARTUP_CANVASS_TIMEOUT_PROP_NAME
  - electionTimeoutNs
```
public static long electionTimeoutNs()
```
    Timeout waiting for votes to become leader in an election.
    
    Returns:
    
    timeout in nanoseconds to wait for votes to become leader in an election.
    
    See Also:
    
    ELECTION_TIMEOUT_PROP_NAME
  - electionStatusIntervalNs
```
public static long electionStatusIntervalNs()
```
    Interval at which a member will send out status messages during the election phases.
    
    Returns:
    
    interval at which a member will send out status messages during the election phases.
    
    See Also:
    
    ELECTION_STATUS_INTERVAL_PROP_NAME
  - dynamicJoinIntervalNs
```
public static long dynamicJoinIntervalNs()
```
    Interval at which a dynamic joining member will send out add cluster members and snapshot recording queries.
    
    Returns:
    
    Interval at which a dynamic joining member will send out add cluster members and snapshot recording queries.
    
    See Also:
    
    DYNAMIC_JOIN_INTERVAL_PROP_NAME
  - terminationTimeoutNs
```
public static long terminationTimeoutNs()
```
    Timeout waiting for follower termination by leader.
    
    Returns:
    
    timeout in nanoseconds to wait followers to terminate.
    
    See Also:
    
    TERMINATION_TIMEOUT_PROP_NAME
  - errorBufferLength
```
public static int errorBufferLength()
```
    Size in bytes of the error buffer in the mark file.
    
    Returns:
    
    length of error buffer in bytes.
    
    See Also:
    
    ERROR_BUFFER_LENGTH_PROP_NAME
  - authenticatorSupplier
```
public static AuthenticatorSupplier authenticatorSupplier()
```
    The value AUTHENTICATOR_SUPPLIER_DEFAULT or system property AUTHENTICATOR_SUPPLIER_PROP_NAME if set.
    
    Returns:
    
    AUTHENTICATOR_SUPPLIER_DEFAULT or system property AUTHENTICATOR_SUPPLIER_PROP_NAME if set.
  - memberStatusChannel
```
public static String memberStatusChannel()
```
    The value MEMBER_STATUS_CHANNEL_DEFAULT or system property MEMBER_STATUS_CHANNEL_PROP_NAME if set.
    
    Returns:
    
    MEMBER_STATUS_CHANNEL_DEFAULT or system property MEMBER_STATUS_CHANNEL_PROP_NAME if set.
  - memberStatusStreamId
```
public static int memberStatusStreamId()
```
    The value MEMBER_STATUS_STREAM_ID_DEFAULT or system property MEMBER_STATUS_STREAM_ID_PROP_NAME if set.
    
    Returns:
    
    MEMBER_STATUS_STREAM_ID_DEFAULT or system property MEMBER_STATUS_STREAM_ID_PROP_NAME if set.
  - wheelTickResolutionNs
```
public static long wheelTickResolutionNs()
```
    The value WHEEL_TICK_RESOLUTION_DEFAULT_NS or system property WHEEL_TICK_RESOLUTION_PROP_NAME if set.
    
    Returns:
    
    WHEEL_TICK_RESOLUTION_DEFAULT_NS or system property WHEEL_TICK_RESOLUTION_PROP_NAME if set.
  - ticksPerWheel
```
public static int ticksPerWheel()
```
    The value TICKS_PER_WHEEL_DEFAULT or system property CLUSTER_MEMBER_ID_PROP_NAME if set.
    
    Returns:
    
    TICKS_PER_WHEEL_DEFAULT or system property TICKS_PER_WHEEL_PROP_NAME if set.
  - fileSyncLevel
```
public static int fileSyncLevel()
```
    The level at which files should be sync'ed to disk.
    - 0 - normal writes.
    - 1 - sync file data.
    - 2 - sync file data + metadata.
    Returns:
    
    level at which files should be sync'ed to disk.

Class ConsensusModule.Configuration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLUSTER_INGRESS_FRAGMENT_LIMIT_PROP_NAME

CLUSTER_INGRESS_FRAGMENT_LIMIT_DEFAULT

SNAPSHOT_TYPE_ID

SERVICE_ID

CLUSTER_MEMBER_ID_PROP_NAME

CLUSTER_MEMBER_ID_DEFAULT

APPOINTED_LEADER_ID_PROP_NAME

APPOINTED_LEADER_ID_DEFAULT

CLUSTER_MEMBERS_PROP_NAME

CLUSTER_MEMBERS_DEFAULT

CLUSTER_MEMBERS_STATUS_ENDPOINTS_PROP_NAME

CLUSTER_MEMBERS_STATUS_ENDPOINTS_DEFAULT

CLUSTER_MEMBERS_IGNORE_SNAPSHOT_PROP_NAME

CLUSTER_MEMBERS_IGNORE_SNAPSHOT_DEFAULT

LOG_CHANNEL_PROP_NAME

LOG_CHANNEL_DEFAULT

MEMBER_ENDPOINTS_PROP_NAME

MEMBER_ENDPOINTS_DEFAULT

LOG_STREAM_ID_PROP_NAME

LOG_STREAM_ID_DEFAULT

SNAPSHOT_CHANNEL_DEFAULT

SNAPSHOT_STREAM_ID_DEFAULT

SESSION_LIMIT_MSG

SESSION_REJECTED_MSG

SESSION_INVALID_VERSION_MSG

MEMBER_STATUS_CHANNEL_PROP_NAME

MEMBER_STATUS_CHANNEL_DEFAULT

MEMBER_STATUS_STREAM_ID_PROP_NAME

MEMBER_STATUS_STREAM_ID_DEFAULT

CONSENSUS_MODULE_STATE_TYPE_ID

CONSENSUS_MODULE_ERROR_COUNT_TYPE_ID

CLUSTER_CLIENT_TIMEOUT_COUNT_TYPE_ID

CLUSTER_INVALID_REQUEST_COUNT_TYPE_ID

CLUSTER_NODE_ROLE_TYPE_ID

CONTROL_TOGGLE_TYPE_ID

COMMIT_POSITION_TYPE_ID

RECOVERY_STATE_TYPE_ID

SNAPSHOT_COUNTER_TYPE_ID

ELECTION_STATE_TYPE_ID

SERVICE_COUNT_PROP_NAME

SERVICE_COUNT_DEFAULT

MAX_CONCURRENT_SESSIONS_PROP_NAME

MAX_CONCURRENT_SESSIONS_DEFAULT

SESSION_TIMEOUT_PROP_NAME

SESSION_TIMEOUT_DEFAULT_NS

LEADER_HEARTBEAT_TIMEOUT_PROP_NAME

LEADER_HEARTBEAT_TIMEOUT_DEFAULT_NS

LEADER_HEARTBEAT_INTERVAL_PROP_NAME

LEADER_HEARTBEAT_INTERVAL_DEFAULT_NS

STARTUP_CANVASS_TIMEOUT_PROP_NAME

STARTUP_CANVASS_TIMEOUT_DEFAULT_NS

ELECTION_TIMEOUT_PROP_NAME

ELECTION_TIMEOUT_DEFAULT_NS

ELECTION_STATUS_INTERVAL_PROP_NAME

ELECTION_STATUS_INTERVAL_DEFAULT_NS

DYNAMIC_JOIN_INTERVAL_PROP_NAME

DYNAMIC_JOIN_INTERVAL_DEFAULT_NS

AUTHENTICATOR_SUPPLIER_PROP_NAME

AUTHENTICATOR_SUPPLIER_DEFAULT

ERROR_BUFFER_LENGTH_PROP_NAME

ERROR_BUFFER_LENGTH_DEFAULT

TERMINATION_TIMEOUT_PROP_NAME

TERMINATION_TIMEOUT_DEFAULT_NS

WHEEL_TICK_RESOLUTION_PROP_NAME

WHEEL_TICK_RESOLUTION_DEFAULT_NS

TICKS_PER_WHEEL_PROP_NAME

TICKS_PER_WHEEL_DEFAULT

FILE_SYNC_LEVEL_PROP_NAME

FILE_SYNC_LEVEL_DEFAULT

Constructor Detail

Configuration

Method Detail

ingressFragmentLimit

clusterMemberId