ConsensusModule.Context (Aeron Message Transport)

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

All Implemented Interfaces:

Cloneable

Enclosing class:

ConsensusModule
```
public static final class ConsensusModule.Context
extends Object
implements Cloneable
```
Programmable overrides for configuring the ConsensusModule in a cluster.
The context will be owned by ConsensusModuleAgent after a successful ConsensusModule.launch(Context) and closed via ConsensusModule.close().

Constructor Summary

Constructors
Constructor and Description

Context()

Constructors
Constructor and Description
`Context()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Aeron`	`aeron()` `Aeron` client for communicating with the local Media Driver.
`ConsensusModule.Context`	`aeron(Aeron aeron)` `Aeron` client for communicating with the local Media Driver.
`String`	`aeronDirectoryName()` Get the top level Aeron directory used for communication between the Aeron client and Media Driver.
`ConsensusModule.Context`	`aeronDirectoryName(String aeronDirectoryName)` Set the top level Aeron directory used for communication between the Aeron client and Media Driver.
`int`	`appointedLeaderId()` The cluster member id of the appointed cluster leader.
`ConsensusModule.Context`	`appointedLeaderId(int appointedLeaderId)` The cluster member id of the appointed cluster leader.
`int`	`appVersion()` User assigned application version which appended to the log as the appVersion in new leadership events.
`ConsensusModule.Context`	`appVersion(int appVersion)` User assigned application version which appended to the log as the appVersion in new leadership events.
`AeronArchive.Context`	`archiveContext()` Get the `AeronArchive.Context` that should be used for communicating with the local Archive.
`ConsensusModule.Context`	`archiveContext(AeronArchive.Context archiveContext)` Set the `AeronArchive.Context` that should be used for communicating with the local Archive.
`AuthenticatorSupplier`	`authenticatorSupplier()` Get the `AuthenticatorSupplier` that should be used for the consensus module.
`ConsensusModule.Context`	`authenticatorSupplier(AuthenticatorSupplier authenticatorSupplier)` Set the `AuthenticatorSupplier` that will be used for the consensus module.
`ConsensusModule.Context`	`clone()` Perform a shallow copy of the object.
`void`	`close()` Close the context and free applicable resources.
`ClusterClock`	`clusterClock()` Get the `ClusterClock` to used for timestamping messages and timers.
`ConsensusModule.Context`	`clusterClock(ClusterClock clock)` Set the `ClusterClock` to be used for timestamping messages and timers.
`String`	`clusterConsensusEndpoints()` The endpoints representing cluster members of the cluster to attempt to contact to join the cluster.
`ConsensusModule.Context`	`clusterConsensusEndpoints(String endpoints)` String representing the cluster members consensus endpoints used to request to join the cluster.
`File`	`clusterDir()` The directory used for for the consensus module directory.
`ConsensusModule.Context`	`clusterDir(File clusterDir)` Set the directory to use for the consensus module directory.
`String`	`clusterDirectoryName()` The directory name to use for the consensus module directory.
`ConsensusModule.Context`	`clusterDirectoryName(String clusterDirectoryName)` Set the directory name to use for the consensus module directory.
`int`	`clusterId()` Get the id for this cluster instance.
`ConsensusModule.Context`	`clusterId(int clusterId)` Set the id for this cluster instance.
`ClusterMarkFile`	`clusterMarkFile()` The `ClusterMarkFile` in use.
`ConsensusModule.Context`	`clusterMarkFile(ClusterMarkFile markFile)` Set the `ClusterMarkFile` in use.
`int`	`clusterMemberId()` This cluster member identity.
`ConsensusModule.Context`	`clusterMemberId(int clusterMemberId)` This cluster member identity.
`String`	`clusterMembers()` The endpoints representing members of the cluster which are all candidates to be leader.
`ConsensusModule.Context`	`clusterMembers(String clusterMembers)` String representing the cluster members.
`boolean`	`clusterMembersIgnoreSnapshot()` Whether the cluster members in the snapshot should be ignored or not.
`ConsensusModule.Context`	`clusterMembersIgnoreSnapshot(boolean ignore)` Whether the cluster members in the snapshot should be ignored or not.
`Counter`	`clusterNodeRoleCounter()` Get the counter for representing the current `Cluster.Role` of the consensus module node.
`ConsensusModule.Context`	`clusterNodeRoleCounter(Counter nodeRole)` Set the counter for representing the current `Cluster.Role` of the cluster node.
`Counter`	`commitPositionCounter()` Get the counter for the commit position the cluster has reached for consensus.
`ConsensusModule.Context`	`commitPositionCounter(Counter commitPosition)` Set the counter for the commit position the cluster has reached for consensus.
`void`	`conclude()` Conclude configuration by setting up defaults when specifics are not provided.
`String`	`consensusChannel()` Get the channel parameter for the consensus communication channel.
`ConsensusModule.Context`	`consensusChannel(String channel)` Set the channel parameter for the consensus communication channel.
`int`	`consensusModuleStreamId()` Get the stream id for communications from the services to the consensus module.
`ConsensusModule.Context`	`consensusModuleStreamId(int streamId)` Set the stream id for communications from the services to the consensus module.
`int`	`consensusStreamId()` Get the stream id for the consensus channel.
`ConsensusModule.Context`	`consensusStreamId(int streamId)` Set the stream id for the consensus channel.
`String`	`controlChannel()` Get the channel parameter for bi-directional communications between the consensus module and services.
`ConsensusModule.Context`	`controlChannel(String channel)` Set the channel parameter for bi-directional communications between the consensus module and services.
`Counter`	`controlToggleCounter()` Get the counter for the control toggle for triggering actions on the cluster node.
`ConsensusModule.Context`	`controlToggleCounter(Counter controlToggle)` Set the counter for the control toggle for triggering actions on the cluster node.
`CountedErrorHandler`	`countedErrorHandler()` The `errorHandler()` that will increment `errorCounter()` by default.
`ConsensusModule.Context`	`countedErrorHandler(CountedErrorHandler countedErrorHandler)` The `errorHandler()` that will increment `errorCounter()` by default.
`void`	`deleteDirectory()` Delete the cluster directory.
`boolean`	`deleteDirOnStart()` Will the consensus module attempt to immediately delete `clusterDir()` on startup.
`ConsensusModule.Context`	`deleteDirOnStart(boolean deleteDirOnStart)` Should the consensus module attempt to immediately delete `clusterDir()` on startup.
`long`	`dynamicJoinIntervalNs()` Interval at which a dynamic joining member will send add cluster member and snapshot recording queries.
`ConsensusModule.Context`	`dynamicJoinIntervalNs(long dynamicJoinIntervalNs)` Interval at which a dynamic joining member will send add cluster member and snapshot recording queries.
`Counter`	`electionStateCounter()` Get the counter for the current state of an election
`ConsensusModule.Context`	`electionStateCounter(Counter electionStateCounter)` Set the counter for the current state of an election.
`long`	`electionStatusIntervalNs()` Interval at which a member will send out status messages during the election phases.
`ConsensusModule.Context`	`electionStatusIntervalNs(long electionStatusIntervalNs)` Interval at which a member will send out status messages during the election phases.
`long`	`electionTimeoutNs()` Timeout to wait for votes in an election before declaring the election void and starting over.
`ConsensusModule.Context`	`electionTimeoutNs(long timeoutNs)` Timeout to wait for votes in an election before declaring the election void and starting over.
`EpochClock`	`epochClock()` Get the `EpochClock` to used for tracking wall clock time.
`ConsensusModule.Context`	`epochClock(EpochClock clock)` Set the `EpochClock` to be used for tracking wall clock time.
`int`	`errorBufferLength()` The error buffer length in bytes.
`ConsensusModule.Context`	`errorBufferLength(int errorBufferLength)` Set the error buffer length in bytes to use.
`AtomicCounter`	`errorCounter()` Get the error counter that will record the number of errors observed.
`ConsensusModule.Context`	`errorCounter(AtomicCounter errorCounter)` Set the error counter that will record the number of errors observed.
`ErrorHandler`	`errorHandler()` Get the `ErrorHandler` to be used by the Consensus Module.
`ConsensusModule.Context`	`errorHandler(ErrorHandler errorHandler)` Set the `ErrorHandler` to be used by the Consensus Module.
`DistinctErrorLog`	`errorLog()` The `DistinctErrorLog` in use.
`ConsensusModule.Context`	`errorLog(DistinctErrorLog errorLog)` Set the `DistinctErrorLog` in use.
`ConsensusModule.Context`	`fileSyncLevel(int syncLevel)` Set level at which files should be sync'ed to disk.
`IdleStrategy`	`idleStrategy()` Get a new `IdleStrategy` based on configured supplier.
`ConsensusModule.Context`	`idleStrategySupplier(Supplier<IdleStrategy> idleStrategySupplier)` Provides an `IdleStrategy` supplier for the idle strategy for the agent duty cycle.
`String`	`ingressChannel()` Get the channel parameter for the ingress channel.
`ConsensusModule.Context`	`ingressChannel(String channel)` Set the channel parameter for the ingress channel.
`int`	`ingressFragmentLimit()` The limit for fragments to be consumed on each poll of ingress.
`ConsensusModule.Context`	`ingressFragmentLimit(int ingressFragmentLimit)` Set limit for fragments to be consumed on each poll of ingress.
`int`	`ingressStreamId()` Get the stream id for the ingress channel.
`ConsensusModule.Context`	`ingressStreamId(int streamId)` Set the stream id for the ingress channel.
`long`	`leaderHeartbeatIntervalNs()` Interval at which a leader will send heartbeats if the log is not progressing.
`ConsensusModule.Context`	`leaderHeartbeatIntervalNs(long heartbeatIntervalNs)` Interval at which a leader will send heartbeats if the log is not progressing.
`long`	`leaderHeartbeatTimeoutNs()` Timeout for a leader if no heartbeat is received by an other member.
`ConsensusModule.Context`	`leaderHeartbeatTimeoutNs(long heartbeatTimeoutNs)` Timeout for a leader if no heartbeat is received by an other member.
`String`	`logChannel()` Get the channel parameter for the cluster log channel.
`ConsensusModule.Context`	`logChannel(String channel)` Set the channel parameter for the cluster log channel.
`int`	`logFragmentLimit()` Get the fragment limit to be used when polling the log `Subscription`.
`ConsensusModule.Context`	`logFragmentLimit(int logFragmentLimit)` Set the fragment limit to be used when polling the log `Subscription`.
`int`	`logStreamId()` Get the stream id for the cluster log channel.
`ConsensusModule.Context`	`logStreamId(int streamId)` Set the stream id for the cluster log channel.
`int`	`maxConcurrentSessions()` Get the limit for the maximum number of concurrent cluster sessions.
`ConsensusModule.Context`	`maxConcurrentSessions(int maxSessions)` Set the limit for the maximum number of concurrent cluster sessions.
`String`	`memberEndpoints()` Get the endpoints for this cluster node.
`ConsensusModule.Context`	`memberEndpoints(String endpoints)` Set the endpoints for this cluster node.
`Counter`	`moduleStateCounter()` Get the counter for the current state of the consensus module.
`ConsensusModule.Context`	`moduleStateCounter(Counter moduleState)` Set the counter for the current state of the consensus module.
`boolean`	`ownsAeronClient()` Does this context own the `aeron()` client and this takes responsibility for closing it?
`ConsensusModule.Context`	`ownsAeronClient(boolean ownsAeronClient)` Does this context own the `aeron()` client and this takes responsibility for closing it?
`Random`	`random()` The source of random values for timeouts used in elections.
`ConsensusModule.Context`	`random(Random random)` The source of random values for timeouts used in elections.
`RecordingLog`	`recordingLog()` The `RecordingLog` for the log terms and snapshots.
`ConsensusModule.Context`	`recordingLog(RecordingLog recordingLog)` Set the `RecordingLog` for the log terms and snapshots.
`String`	`replayChannel()` Get the channel parameter for the cluster log and snapshot replay channel.
`ConsensusModule.Context`	`replayChannel(String channel)` Set the channel parameter for the cluster log and snapshot replay channel.
`int`	`replayStreamId()` Get the stream id for the cluster log and snapshot replay channel.
`ConsensusModule.Context`	`replayStreamId(int streamId)` Set the stream id for the cluster log and snapshot replay channel.
`int`	`serviceCount()` Get the number of clustered services in this cluster instance.
`ConsensusModule.Context`	`serviceCount(int serviceCount)` Set the number of clustered services in this cluster instance.
`int`	`serviceStreamId()` Get the stream id for communications from the consensus module and to the services.
`ConsensusModule.Context`	`serviceStreamId(int streamId)` Set the stream id for communications from the consensus module and to the services.
`long`	`sessionTimeoutNs()` Timeout for a session if no activity is observed.
`ConsensusModule.Context`	`sessionTimeoutNs(long sessionTimeoutNs)` Timeout for a session if no activity is observed.
`ShutdownSignalBarrier`	`shutdownSignalBarrier()` Get the `ShutdownSignalBarrier` that can be used to shutdown a consensus module.
`ConsensusModule.Context`	`shutdownSignalBarrier(ShutdownSignalBarrier barrier)` Set the `ShutdownSignalBarrier` that can be used to shutdown a consensus module.
`String`	`snapshotChannel()` Get the channel parameter for snapshot recordings.
`ConsensusModule.Context`	`snapshotChannel(String channel)` Set the channel parameter for snapshot recordings.
`Counter`	`snapshotCounter()` Get the counter for the count of snapshots taken.
`ConsensusModule.Context`	`snapshotCounter(Counter snapshotCounter)` Set the counter for the count of snapshots taken.
`int`	`snapshotStreamId()` Get the stream id for snapshot recordings.
`ConsensusModule.Context`	`snapshotStreamId(int streamId)` Set the stream id for snapshot recordings.
`long`	`startupCanvassTimeoutNs()` Timeout to wait for hearing the status of all cluster members on startup after recovery before commencing an election if a majority of members has been heard from.
`ConsensusModule.Context`	`startupCanvassTimeoutNs(long timeoutNs)` Timeout to wait for hearing the status of all cluster members on startup after recovery before commencing an election if a majority of members has been heard from.
`Runnable`	`terminationHook()` Get the `Runnable` that is called when the `ConsensusModule` processes a termination action.
`ConsensusModule.Context`	`terminationHook(Runnable terminationHook)` Set the `Runnable` that is called when the `ConsensusModule` processes a termination action.
`long`	`terminationTimeoutNs()` Timeout to wait for follower termination by leader.
`ConsensusModule.Context`	`terminationTimeoutNs(long terminationTimeoutNs)` Timeout to wait for follower termination by leader.
`ThreadFactory`	`threadFactory()` Get the thread factory used for creating threads.
`ConsensusModule.Context`	`threadFactory(ThreadFactory threadFactory)` Set the thread factory used for creating threads.
`int`	`ticksPerWheel()` Number of ticks, or spokes, on the timer wheel.
`ConsensusModule.Context`	`ticksPerWheel(int ticksPerWheel)` Number of ticks, or spokes, on the timer wheel.
`Counter`	`timedOutClientCounter()` Get the counter for the count of clients that have been timed out and disconnected.
`ConsensusModule.Context`	`timedOutClientCounter(Counter timedOutClientCounter)` Set the counter for the count of clients that have been timed out and disconnected.
`long`	`wheelTickResolutionNs()` Resolution in nanoseconds for each tick of the timer wheel for scheduling deadlines.
`ConsensusModule.Context`	`wheelTickResolutionNs(long wheelTickResolutionNs)` Resolution in nanoseconds for each tick of the timer wheel for scheduling deadlines.

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

- Constructor Detail
  - Context
```
public Context()
```
- Method Detail
  - clone
```
public ConsensusModule.Context clone()
```
    Perform a shallow copy of the object.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a shallow copy of the object.
  - conclude
```
public void conclude()
```
    Conclude configuration by setting up defaults when specifics are not provided.
  - deleteDirOnStart
```
public ConsensusModule.Context deleteDirOnStart(boolean deleteDirOnStart)
```
    Should the consensus module attempt to immediately delete clusterDir() on startup.
    
    Parameters:
    
    deleteDirOnStart - Attempt deletion.
    
    Returns:
    
    this for a fluent API.
  - deleteDirOnStart
```
public boolean deleteDirOnStart()
```
    Will the consensus module attempt to immediately delete clusterDir() on startup.
    
    Returns:
    
    true when directory will be deleted, otherwise false.
  - clusterDirectoryName
```
public ConsensusModule.Context clusterDirectoryName(String clusterDirectoryName)
```
    Set the directory name to use for the consensus module directory.
    
    Parameters:
    
    clusterDirectoryName - to use.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CLUSTER_DIR_PROP_NAME
  - clusterDirectoryName
```
public String clusterDirectoryName()
```
    The directory name to use for the consensus module directory.
    
    Returns:
    
    directory name for the consensus module directory.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CLUSTER_DIR_PROP_NAME
  - clusterDir
```
public ConsensusModule.Context clusterDir(File clusterDir)
```
    Set the directory to use for the consensus module directory.
    
    Parameters:
    
    clusterDir - to use.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CLUSTER_DIR_PROP_NAME
  - clusterDir
```
public File clusterDir()
```
    The directory used for for the consensus module directory.
    
    Returns:
    
    directory for for the consensus module directory.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CLUSTER_DIR_PROP_NAME
  - recordingLog
```
public ConsensusModule.Context recordingLog(RecordingLog recordingLog)
```
    Set the RecordingLog for the log terms and snapshots.
    
    Parameters:
    
    recordingLog - to use.
    
    Returns:
    
    this for a fluent API.
  - recordingLog
```
public RecordingLog recordingLog()
```
    The RecordingLog for the log terms and snapshots.
    
    Returns:
    
    RecordingLog for the log terms and snapshots.
  - appVersion
```
public ConsensusModule.Context appVersion(int appVersion)
```
    User assigned application version which appended to the log as the appVersion in new leadership events.
    This can be validated using SemanticVersion to ensure only application nodes of the same major version communicate with each other.
    
    Parameters:
    
    appVersion - for user application.
    
    Returns:
    
    this for a fluent API.
  - appVersion
```
public int appVersion()
```
    User assigned application version which appended to the log as the appVersion in new leadership events.
    This can be validated using SemanticVersion to ensure only application nodes of the same major version communicate with each other.
    
    Returns:
    
    appVersion for user application.
  - fileSyncLevel
```
public ConsensusModule.Context fileSyncLevel(int syncLevel)
```
    Set level at which files should be sync'ed to disk.
    - 0 - normal writes.
    - 1 - sync file data.
    - 2 - sync file data + metadata.
    Parameters:
    
    syncLevel - to be applied for file writes.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.FILE_SYNC_LEVEL_PROP_NAME
  - clusterId
```
public ConsensusModule.Context clusterId(int clusterId)
```
    Set the id for this cluster instance. This must match with the service containers.
    
    Parameters:
    
    clusterId - for this clustered instance.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CLUSTER_ID_PROP_NAME
  - clusterId
```
public int clusterId()
```
    Get the id for this cluster instance. This must match with the service containers.
    
    Returns:
    
    the id for this cluster instance.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CLUSTER_ID_PROP_NAME
  - clusterMemberId
```
public ConsensusModule.Context clusterMemberId(int clusterMemberId)
```
    This cluster member identity.
    
    Parameters:
    
    clusterMemberId - for this member.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.CLUSTER_MEMBER_ID_PROP_NAME
  - clusterMemberId
```
public int clusterMemberId()
```
    This cluster member identity.
    
    Returns:
    
    this cluster member identity.
    
    See Also:
    
    ConsensusModule.Configuration.CLUSTER_MEMBER_ID_PROP_NAME
  - appointedLeaderId
```
public ConsensusModule.Context appointedLeaderId(int appointedLeaderId)
```
    The cluster member id of the appointed cluster leader.
    -1 means no leader has been appointed and an automated leader election should occur.
    
    Parameters:
    
    appointedLeaderId - for the cluster.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.APPOINTED_LEADER_ID_PROP_NAME
  - appointedLeaderId
```
public int appointedLeaderId()
```
    The cluster member id of the appointed cluster leader.
    -1 means no leader has been appointed and an automated leader election should occur.
    
    Returns:
    
    cluster member id of the appointed cluster leader.
    
    See Also:
    
    ConsensusModule.Configuration.APPOINTED_LEADER_ID_PROP_NAME
  - clusterMembers
```
public ConsensusModule.Context clusterMembers(String clusterMembers)
```
    String representing the cluster members.
    0,ingress:port,consensus:port,log:port,catchup:port,archive:port| \ 1,ingress:port,consensus:port,log:port,catchup:port,archive:port| ...
    The ingress endpoints will be used as the endpoint substituted into the ingressChannel() if the endpoint is not provided unless it is multicast.
    
    Parameters:
    
    clusterMembers - which are all candidates to be leader.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.CLUSTER_MEMBERS_PROP_NAME
  - clusterMembers
```
public String clusterMembers()
```
    The endpoints representing members of the cluster which are all candidates to be leader.
    The ingress endpoints will be used as the endpoint in ingressChannel() if the endpoint is not provided in that when it is not multicast.
    
    Returns:
    
    members of the cluster which are all candidates to be leader.
    
    See Also:
    
    ConsensusModule.Configuration.CLUSTER_MEMBERS_PROP_NAME
  - clusterConsensusEndpoints
```
public ConsensusModule.Context clusterConsensusEndpoints(String endpoints)
```
    String representing the cluster members consensus endpoints used to request to join the cluster.
    "endpoint,endpoint,endpoint"
    
    Parameters:
    
    endpoints - which are to be contacted for joining the cluster.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.CLUSTER_CONSENSUS_ENDPOINTS_PROP_NAME
  - clusterConsensusEndpoints
```
public String clusterConsensusEndpoints()
```
    The endpoints representing cluster members of the cluster to attempt to contact to join the cluster.
    
    Returns:
    
    members of the cluster to attempt to request to join from.
    
    See Also:
    
    ConsensusModule.Configuration.CLUSTER_CONSENSUS_ENDPOINTS_PROP_NAME
  - clusterMembersIgnoreSnapshot
```
public ConsensusModule.Context clusterMembersIgnoreSnapshot(boolean ignore)
```
    Whether the cluster members in the snapshot should be ignored or not.
    
    Parameters:
    
    ignore - or not the cluster members in the snapshot.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.CLUSTER_MEMBERS_IGNORE_SNAPSHOT_PROP_NAME
  - clusterMembersIgnoreSnapshot
```
public boolean clusterMembersIgnoreSnapshot()
```
    Whether the cluster members in the snapshot should be ignored or not.
    
    Returns:
    
    ignore or not the cluster members in the snapshot.
    
    See Also:
    
    ConsensusModule.Configuration.CLUSTER_MEMBERS_IGNORE_SNAPSHOT_PROP_NAME
  - ingressChannel
```
public ConsensusModule.Context ingressChannel(String channel)
```
    Set the channel parameter for the ingress channel.
    
    Parameters:
    
    channel - parameter for the ingress channel.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    AeronCluster.Configuration.INGRESS_CHANNEL_PROP_NAME
  - ingressChannel
```
public String ingressChannel()
```
    Get the channel parameter for the ingress channel.
    
    Returns:
    
    the channel parameter for the ingress channel.
    
    See Also:
    
    AeronCluster.Configuration.INGRESS_CHANNEL_PROP_NAME
  - ingressStreamId
```
public ConsensusModule.Context ingressStreamId(int streamId)
```
    Set the stream id for the ingress channel.
    
    Parameters:
    
    streamId - for the ingress channel.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    AeronCluster.Configuration.INGRESS_STREAM_ID_PROP_NAME
  - ingressStreamId
```
public int ingressStreamId()
```
    Get the stream id for the ingress channel.
    
    Returns:
    
    the stream id for the ingress channel.
    
    See Also:
    
    AeronCluster.Configuration.INGRESS_STREAM_ID_PROP_NAME
  - ingressFragmentLimit
```
public ConsensusModule.Context ingressFragmentLimit(int ingressFragmentLimit)
```
    Set limit for fragments to be consumed on each poll of ingress.
    
    Parameters:
    
    ingressFragmentLimit - for the ingress channel.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ConsensusModule.Configuration.CLUSTER_INGRESS_FRAGMENT_LIMIT_PROP_NAME
  - ingressFragmentLimit
```
public int ingressFragmentLimit()
```
    The limit for fragments to be consumed on each poll of ingress.
    
    Returns:
    
    the limit for fragments to be consumed on each poll of ingress.
    
    See Also:
    
    ConsensusModule.Configuration.CLUSTER_INGRESS_FRAGMENT_LIMIT_PROP_NAME
  - logChannel
```
public ConsensusModule.Context logChannel(String channel)
```
    Set the channel parameter for the cluster log channel.
    
    Parameters:
    
    channel - parameter for the cluster log channel.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.LOG_CHANNEL_PROP_NAME
  - logChannel
```
public String logChannel()
```
    Get the channel parameter for the cluster log channel.
    
    Returns:
    
    the channel parameter for the cluster channel.
    
    See Also:
    
    ConsensusModule.Configuration.LOG_CHANNEL_PROP_NAME
  - logStreamId
```
public ConsensusModule.Context logStreamId(int streamId)
```
    Set the stream id for the cluster log channel.
    
    Parameters:
    
    streamId - for the cluster log channel.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ConsensusModule.Configuration.LOG_STREAM_ID_PROP_NAME
  - logStreamId
```
public int logStreamId()
```
    Get the stream id for the cluster log channel.
    
    Returns:
    
    the stream id for the cluster log channel.
    
    See Also:
    
    ConsensusModule.Configuration.LOG_STREAM_ID_PROP_NAME
  - memberEndpoints
```
public ConsensusModule.Context memberEndpoints(String endpoints)
```
    Set the endpoints for this cluster node.
    
    Parameters:
    
    endpoints - for the cluster node.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.MEMBER_ENDPOINTS_PROP_NAME
  - memberEndpoints
```
public String memberEndpoints()
```
    Get the endpoints for this cluster node.
    
    Returns:
    
    the endpoints for the cluster node.
    
    See Also:
    
    ConsensusModule.Configuration.MEMBER_ENDPOINTS_PROP_NAME
  - replayChannel
```
public ConsensusModule.Context replayChannel(String channel)
```
    Set the channel parameter for the cluster log and snapshot replay channel.
    
    Parameters:
    
    channel - parameter for the cluster log replay channel.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.REPLAY_CHANNEL_PROP_NAME
  - replayChannel
```
public String replayChannel()
```
    Get the channel parameter for the cluster log and snapshot replay channel.
    
    Returns:
    
    the channel parameter for the cluster replay channel.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.REPLAY_CHANNEL_PROP_NAME
  - replayStreamId
```
public ConsensusModule.Context replayStreamId(int streamId)
```
    Set the stream id for the cluster log and snapshot replay channel.
    
    Parameters:
    
    streamId - for the cluster log replay channel.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ClusteredServiceContainer.Configuration.REPLAY_STREAM_ID_PROP_NAME
  - replayStreamId
```
public int replayStreamId()
```
    Get the stream id for the cluster log and snapshot replay channel.
    
    Returns:
    
    the stream id for the cluster log replay channel.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.REPLAY_STREAM_ID_PROP_NAME
  - controlChannel
```
public ConsensusModule.Context controlChannel(String channel)
```
    Set the channel parameter for bi-directional communications between the consensus module and services.
    
    Parameters:
    
    channel - parameter for bi-directional communications between the consensus module and services.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CONTROL_CHANNEL_PROP_NAME
  - controlChannel
```
public String controlChannel()
```
    Get the channel parameter for bi-directional communications between the consensus module and services.
    
    Returns:
    
    the channel parameter for bi-directional communications between the consensus module and services.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CONTROL_CHANNEL_PROP_NAME
  - serviceStreamId
```
public ConsensusModule.Context serviceStreamId(int streamId)
```
    Set the stream id for communications from the consensus module and to the services.
    
    Parameters:
    
    streamId - for communications from the consensus module and to the services.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ClusteredServiceContainer.Configuration.SERVICE_STREAM_ID_PROP_NAME
  - serviceStreamId
```
public int serviceStreamId()
```
    Get the stream id for communications from the consensus module and to the services.
    
    Returns:
    
    the stream id for communications from the consensus module and to the services.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.SERVICE_STREAM_ID_PROP_NAME
  - consensusModuleStreamId
```
public ConsensusModule.Context consensusModuleStreamId(int streamId)
```
    Set the stream id for communications from the services to the consensus module.
    
    Parameters:
    
    streamId - for communications from the services to the consensus module.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CONSENSUS_MODULE_STREAM_ID_PROP_NAME
  - consensusModuleStreamId
```
public int consensusModuleStreamId()
```
    Get the stream id for communications from the services to the consensus module.
    
    Returns:
    
    the stream id for communications from the services to the consensus module.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CONSENSUS_MODULE_STREAM_ID_PROP_NAME
  - snapshotChannel
```
public ConsensusModule.Context snapshotChannel(String channel)
```
    Set the channel parameter for snapshot recordings.
    
    Parameters:
    
    channel - parameter for snapshot recordings
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.SNAPSHOT_CHANNEL_PROP_NAME
  - snapshotChannel
```
public String snapshotChannel()
```
    Get the channel parameter for snapshot recordings.
    
    Returns:
    
    the channel parameter for snapshot recordings.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.SNAPSHOT_CHANNEL_PROP_NAME
  - snapshotStreamId
```
public ConsensusModule.Context snapshotStreamId(int streamId)
```
    Set the stream id for snapshot recordings.
    
    Parameters:
    
    streamId - for snapshot recordings.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ClusteredServiceContainer.Configuration.SNAPSHOT_STREAM_ID_PROP_NAME
  - snapshotStreamId
```
public int snapshotStreamId()
```
    Get the stream id for snapshot recordings.
    
    Returns:
    
    the stream id for snapshot recordings.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.SNAPSHOT_STREAM_ID_PROP_NAME
  - consensusChannel
```
public ConsensusModule.Context consensusChannel(String channel)
```
    Set the channel parameter for the consensus communication channel.
    
    Parameters:
    
    channel - parameter for the consensus communication channel.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.CONSENSUS_CHANNEL_PROP_NAME
  - consensusChannel
```
public String consensusChannel()
```
    Get the channel parameter for the consensus communication channel.
    
    Returns:
    
    the channel parameter for the consensus communication channel.
    
    See Also:
    
    ConsensusModule.Configuration.CONSENSUS_CHANNEL_PROP_NAME
  - consensusStreamId
```
public ConsensusModule.Context consensusStreamId(int streamId)
```
    Set the stream id for the consensus channel.
    
    Parameters:
    
    streamId - for the consensus channel.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ConsensusModule.Configuration.CONSENSUS_STREAM_ID_PROP_NAME
  - consensusStreamId
```
public int consensusStreamId()
```
    Get the stream id for the consensus channel.
    
    Returns:
    
    the stream id for the consensus channel.
    
    See Also:
    
    ConsensusModule.Configuration.CONSENSUS_STREAM_ID_PROP_NAME
  - logFragmentLimit
```
public ConsensusModule.Context logFragmentLimit(int logFragmentLimit)
```
    Set the fragment limit to be used when polling the log Subscription.
    
    Parameters:
    
    logFragmentLimit - for this clustered service.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ClusteredServiceContainer.Configuration.LOG_FRAGMENT_LIMIT_DEFAULT
  - logFragmentLimit
```
public int logFragmentLimit()
```
    Get the fragment limit to be used when polling the log Subscription.
    
    Returns:
    
    the fragment limit to be used when polling the log Subscription.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.LOG_FRAGMENT_LIMIT_PROP_NAME
  - wheelTickResolutionNs
```
public ConsensusModule.Context wheelTickResolutionNs(long wheelTickResolutionNs)
```
    Resolution in nanoseconds for each tick of the timer wheel for scheduling deadlines.
    
    Parameters:
    
    wheelTickResolutionNs - the resolution in nanoseconds of each tick on the timer wheel.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ConsensusModule.Configuration.WHEEL_TICK_RESOLUTION_PROP_NAME
  - wheelTickResolutionNs
```
public long wheelTickResolutionNs()
```
    Resolution in nanoseconds for each tick of the timer wheel for scheduling deadlines.
    
    Returns:
    
    the resolution in nanoseconds for each tick on the timer wheel.
    
    See Also:
    
    ConsensusModule.Configuration.WHEEL_TICK_RESOLUTION_PROP_NAME
  - ticksPerWheel
```
public ConsensusModule.Context ticksPerWheel(int ticksPerWheel)
```
    Number of ticks, or spokes, on the timer wheel. Higher number of ticks reduces potential conflicts traded off against memory usage.
    
    Parameters:
    
    ticksPerWheel - the number of ticks on the timer wheel.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ConsensusModule.Configuration.TICKS_PER_WHEEL_PROP_NAME
  - ticksPerWheel
```
public int ticksPerWheel()
```
    Number of ticks, or spokes, on the timer wheel. Higher number of ticks reduces potential conflicts traded off against memory usage.
    
    Returns:
    
    the number of ticks on the timer wheel.
    
    See Also:
    
    ConsensusModule.Configuration.TICKS_PER_WHEEL_PROP_NAME
  - serviceCount
```
public ConsensusModule.Context serviceCount(int serviceCount)
```
    Set the number of clustered services in this cluster instance.
    
    Parameters:
    
    serviceCount - the number of clustered services in this cluster instance.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ConsensusModule.Configuration.SERVICE_COUNT_PROP_NAME, ClusteredServiceContainer.Configuration.SERVICE_ID_PROP_NAME
  - serviceCount
```
public int serviceCount()
```
    Get the number of clustered services in this cluster instance.
    
    Returns:
    
    the number of clustered services in this cluster instance.
    
    See Also:
    
    ConsensusModule.Configuration.SERVICE_COUNT_PROP_NAME, ClusteredServiceContainer.Configuration.SERVICE_ID_PROP_NAME
  - maxConcurrentSessions
```
public ConsensusModule.Context maxConcurrentSessions(int maxSessions)
```
    Set the limit for the maximum number of concurrent cluster sessions.
    
    Parameters:
    
    maxSessions - after which new sessions will be rejected.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ConsensusModule.Configuration.MAX_CONCURRENT_SESSIONS_PROP_NAME
  - maxConcurrentSessions
```
public int maxConcurrentSessions()
```
    Get the limit for the maximum number of concurrent cluster sessions.
    
    Returns:
    
    the limit for the maximum number of concurrent cluster sessions.
    
    See Also:
    
    ConsensusModule.Configuration.MAX_CONCURRENT_SESSIONS_PROP_NAME
  - sessionTimeoutNs
```
public ConsensusModule.Context sessionTimeoutNs(long sessionTimeoutNs)
```
    Timeout for a session if no activity is observed.
    
    Parameters:
    
    sessionTimeoutNs - to wait for activity on a session.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.SESSION_TIMEOUT_PROP_NAME
  - sessionTimeoutNs
```
public long sessionTimeoutNs()
```
    Timeout for a session if no activity is observed.
    
    Returns:
    
    the timeout for a session if no activity is observed.
    
    See Also:
    
    ConsensusModule.Configuration.SESSION_TIMEOUT_PROP_NAME
  - leaderHeartbeatTimeoutNs
```
public ConsensusModule.Context leaderHeartbeatTimeoutNs(long heartbeatTimeoutNs)
```
    Timeout for a leader if no heartbeat is received by an other member.
    
    Parameters:
    
    heartbeatTimeoutNs - to wait for heartbeat from a leader.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.LEADER_HEARTBEAT_TIMEOUT_PROP_NAME
  - leaderHeartbeatTimeoutNs
```
public long leaderHeartbeatTimeoutNs()
```
    Timeout for a leader if no heartbeat is received by an other member.
    
    Returns:
    
    the timeout for a leader if no heartbeat is received by an other member.
    
    See Also:
    
    ConsensusModule.Configuration.LEADER_HEARTBEAT_TIMEOUT_PROP_NAME
  - leaderHeartbeatIntervalNs
```
public ConsensusModule.Context leaderHeartbeatIntervalNs(long heartbeatIntervalNs)
```
    Interval at which a leader will send heartbeats if the log is not progressing.
    
    Parameters:
    
    heartbeatIntervalNs - between leader heartbeats.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.LEADER_HEARTBEAT_INTERVAL_PROP_NAME
  - leaderHeartbeatIntervalNs
```
public long leaderHeartbeatIntervalNs()
```
    Interval at which a leader will send heartbeats if the log is not progressing.
    
    Returns:
    
    the interval at which a leader will send heartbeats if the log is not progressing.
    
    See Also:
    
    ConsensusModule.Configuration.LEADER_HEARTBEAT_INTERVAL_PROP_NAME
  - startupCanvassTimeoutNs
```
public ConsensusModule.Context startupCanvassTimeoutNs(long timeoutNs)
```
    Timeout to wait for hearing the status of all cluster members on startup after recovery before commencing an election if a majority of members has been heard from.
    
    Parameters:
    
    timeoutNs - to wait on startup after recovery before commencing an election.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.STARTUP_CANVASS_TIMEOUT_PROP_NAME
  - startupCanvassTimeoutNs
```
public long startupCanvassTimeoutNs()
```
    Timeout to wait for hearing the status of all cluster members on startup after recovery before commencing an election if a majority of members has been heard from.
    
    Returns:
    
    the timeout to wait on startup after recovery before commencing an election.
    
    See Also:
    
    ConsensusModule.Configuration.STARTUP_CANVASS_TIMEOUT_PROP_NAME
  - electionTimeoutNs
```
public ConsensusModule.Context electionTimeoutNs(long timeoutNs)
```
    Timeout to wait for votes in an election before declaring the election void and starting over.
    
    Parameters:
    
    timeoutNs - to wait for votes in an elections.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.ELECTION_TIMEOUT_PROP_NAME
  - electionTimeoutNs
```
public long electionTimeoutNs()
```
    Timeout to wait for votes in an election before declaring the election void and starting over.
    
    Returns:
    
    the timeout to wait for votes in an elections.
    
    See Also:
    
    ConsensusModule.Configuration.ELECTION_TIMEOUT_PROP_NAME
  - electionStatusIntervalNs
```
public ConsensusModule.Context electionStatusIntervalNs(long electionStatusIntervalNs)
```
    Interval at which a member will send out status messages during the election phases.
    
    Parameters:
    
    electionStatusIntervalNs - between status message updates.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.ELECTION_STATUS_INTERVAL_PROP_NAME, ConsensusModule.Configuration.ELECTION_STATUS_INTERVAL_DEFAULT_NS
  - electionStatusIntervalNs
```
public long electionStatusIntervalNs()
```
    Interval at which a member will send out status messages during the election phases.
    
    Returns:
    
    the interval at which a member will send out status messages during the election phases.
    
    See Also:
    
    ConsensusModule.Configuration.ELECTION_STATUS_INTERVAL_PROP_NAME, ConsensusModule.Configuration.ELECTION_STATUS_INTERVAL_DEFAULT_NS
  - dynamicJoinIntervalNs
```
public ConsensusModule.Context dynamicJoinIntervalNs(long dynamicJoinIntervalNs)
```
    Interval at which a dynamic joining member will send add cluster member and snapshot recording queries.
    
    Parameters:
    
    dynamicJoinIntervalNs - between add cluster members and snapshot recording queries.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.DYNAMIC_JOIN_INTERVAL_PROP_NAME, ConsensusModule.Configuration.DYNAMIC_JOIN_INTERVAL_DEFAULT_NS
  - dynamicJoinIntervalNs
```
public long dynamicJoinIntervalNs()
```
    Interval at which a dynamic joining member will send add cluster member and snapshot recording queries.
    
    Returns:
    
    the interval at which a dynamic joining member will send add cluster member and snapshot recording queries.
    
    See Also:
    
    ConsensusModule.Configuration.DYNAMIC_JOIN_INTERVAL_PROP_NAME, ConsensusModule.Configuration.DYNAMIC_JOIN_INTERVAL_DEFAULT_NS
  - terminationTimeoutNs
```
public ConsensusModule.Context terminationTimeoutNs(long terminationTimeoutNs)
```
    Timeout to wait for follower termination by leader.
    
    Parameters:
    
    terminationTimeoutNs - to wait for follower termination.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.TERMINATION_TIMEOUT_PROP_NAME, ConsensusModule.Configuration.TERMINATION_TIMEOUT_DEFAULT_NS
  - terminationTimeoutNs
```
public long terminationTimeoutNs()
```
    Timeout to wait for follower termination by leader.
    
    Returns:
    
    timeout to wait for follower termination by leader.
    
    See Also:
    
    ConsensusModule.Configuration.TERMINATION_TIMEOUT_PROP_NAME, ConsensusModule.Configuration.TERMINATION_TIMEOUT_DEFAULT_NS
  - threadFactory
```
public ThreadFactory threadFactory()
```
    Get the thread factory used for creating threads.
    
    Returns:
    
    thread factory used for creating threads.
  - threadFactory
```
public ConsensusModule.Context threadFactory(ThreadFactory threadFactory)
```
    Set the thread factory used for creating threads.
    
    Parameters:
    
    threadFactory - used for creating threads
    
    Returns:
    
    this for a fluent API.
  - idleStrategySupplier
```
public ConsensusModule.Context idleStrategySupplier(Supplier<IdleStrategy> idleStrategySupplier)
```
    Provides an IdleStrategy supplier for the idle strategy for the agent duty cycle.
    
    Parameters:
    
    idleStrategySupplier - supplier for the idle strategy for the agent duty cycle.
    
    Returns:
    
    this for a fluent API.
  - idleStrategy
```
public IdleStrategy idleStrategy()
```
    Get a new IdleStrategy based on configured supplier.
    
    Returns:
    
    a new IdleStrategy based on configured supplier.
  - clusterClock
```
public ConsensusModule.Context clusterClock(ClusterClock clock)
```
    Set the ClusterClock to be used for timestamping messages and timers.
    
    Parameters:
    
    clock - ClusterClock to be used for timestamping messages and timers.
    
    Returns:
    
    this for a fluent API.
  - clusterClock
```
public ClusterClock clusterClock()
```
    Get the ClusterClock to used for timestamping messages and timers.
    
    Returns:
    
    the ClusterClock to used for timestamping messages and timers.
  - epochClock
```
public ConsensusModule.Context epochClock(EpochClock clock)
```
    Set the EpochClock to be used for tracking wall clock time.
    
    Parameters:
    
    clock - EpochClock to be used for tracking wall clock time.
    
    Returns:
    
    this for a fluent API.
  - epochClock
```
public EpochClock epochClock()
```
    Get the EpochClock to used for tracking wall clock time.
    
    Returns:
    
    the EpochClock to used for tracking wall clock time.
  - errorHandler
```
public ErrorHandler errorHandler()
```
    Get the ErrorHandler to be used by the Consensus Module.
    
    Returns:
    
    the ErrorHandler to be used by the Consensus Module.
  - errorHandler
```
public ConsensusModule.Context errorHandler(ErrorHandler errorHandler)
```
    Set the ErrorHandler to be used by the Consensus Module.
    
    Parameters:
    
    errorHandler - the error handler to be used by the Consensus Module.
    
    Returns:
    
    this for a fluent API
  - countedErrorHandler
```
public ConsensusModule.Context countedErrorHandler(CountedErrorHandler countedErrorHandler)
```
    The errorHandler() that will increment errorCounter() by default.
    
    Parameters:
    
    countedErrorHandler - to override the default.
    
    Returns:
    
    this for a fluent API.
  - countedErrorHandler
```
public CountedErrorHandler countedErrorHandler()
```
    The errorHandler() that will increment errorCounter() by default.
    
    Returns:
    
    errorHandler() that will increment errorCounter() by default.
  - errorCounter
```
public AtomicCounter errorCounter()
```
    Get the error counter that will record the number of errors observed.
    
    Returns:
    
    the error counter that will record the number of errors observed.
  - errorCounter
```
public ConsensusModule.Context errorCounter(AtomicCounter errorCounter)
```
    Set the error counter that will record the number of errors observed.
    
    Parameters:
    
    errorCounter - the error counter that will record the number of errors observed.
    
    Returns:
    
    this for a fluent API.
  - moduleStateCounter
```
public Counter moduleStateCounter()
```
    Get the counter for the current state of the consensus module.
    
    Returns:
    
    the counter for the current state of the consensus module.
    
    See Also:
    
    ConsensusModule.State
  - moduleStateCounter
```
public ConsensusModule.Context moduleStateCounter(Counter moduleState)
```
    Set the counter for the current state of the consensus module.
    
    Parameters:
    
    moduleState - the counter for the current state of the consensus module.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.State
  - electionStateCounter
```
public Counter electionStateCounter()
```
    Get the counter for the current state of an election
    
    Returns:
    
    the counter for the current state of an election.
    
    See Also:
    
    ElectionState
  - electionStateCounter
```
public ConsensusModule.Context electionStateCounter(Counter electionStateCounter)
```
    Set the counter for the current state of an election.
    
    Parameters:
    
    electionStateCounter - for the current state of an election.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ElectionState
  - commitPositionCounter
```
public Counter commitPositionCounter()
```
    Get the counter for the commit position the cluster has reached for consensus.
    
    Returns:
    
    the counter for the commit position the cluster has reached for consensus.
  - commitPositionCounter
```
public ConsensusModule.Context commitPositionCounter(Counter commitPosition)
```
    Set the counter for the commit position the cluster has reached for consensus.
    
    Parameters:
    
    commitPosition - counter for the commit position the cluster has reached for consensus.
    
    Returns:
    
    this for a fluent API.
  - clusterNodeRoleCounter
```
public Counter clusterNodeRoleCounter()
```
    Get the counter for representing the current Cluster.Role of the consensus module node.
    
    Returns:
    
    the counter for representing the current Cluster.Role of the cluster node.
    
    See Also:
    
    Cluster.Role
  - clusterNodeRoleCounter
```
public ConsensusModule.Context clusterNodeRoleCounter(Counter nodeRole)
```
    Set the counter for representing the current Cluster.Role of the cluster node.
    
    Parameters:
    
    nodeRole - the counter for representing the current Cluster.Role of the cluster node.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    Cluster.Role
  - controlToggleCounter
```
public Counter controlToggleCounter()
```
    Get the counter for the control toggle for triggering actions on the cluster node.
    
    Returns:
    
    the counter for triggering cluster node actions.
    
    See Also:
    
    ClusterControl
  - controlToggleCounter
```
public ConsensusModule.Context controlToggleCounter(Counter controlToggle)
```
    Set the counter for the control toggle for triggering actions on the cluster node.
    
    Parameters:
    
    controlToggle - the counter for triggering cluster node actions.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusterControl
  - snapshotCounter
```
public Counter snapshotCounter()
```
    Get the counter for the count of snapshots taken.
    
    Returns:
    
    the counter for the count of snapshots taken.
  - snapshotCounter
```
public ConsensusModule.Context snapshotCounter(Counter snapshotCounter)
```
    Set the counter for the count of snapshots taken.
    
    Parameters:
    
    snapshotCounter - the count of snapshots taken.
    
    Returns:
    
    this for a fluent API.
  - timedOutClientCounter
```
public Counter timedOutClientCounter()
```
    Get the counter for the count of clients that have been timed out and disconnected.
    
    Returns:
    
    the counter for the count of clients that have been timed out and disconnected.
  - timedOutClientCounter
```
public ConsensusModule.Context timedOutClientCounter(Counter timedOutClientCounter)
```
    Set the counter for the count of clients that have been timed out and disconnected.
    
    Parameters:
    
    timedOutClientCounter - the count of clients that have been timed out and disconnected.
    
    Returns:
    
    this for a fluent API.
  - aeron
```
public ConsensusModule.Context aeron(Aeron aeron)
```
    Aeron client for communicating with the local Media Driver.
    This client will be closed when the ConsensusModule.close() or close() methods are called if ownsAeronClient() is true.
    
    Parameters:
    
    aeron - client for communicating with the local Media Driver.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    Aeron.connect()
  - aeron
```
public Aeron aeron()
```
    Aeron client for communicating with the local Media Driver.
    If not provided then a default will be established during conclude() by calling Aeron.connect().
    
    Returns:
    
    client for communicating with the local Media Driver.
  - aeronDirectoryName
```
public ConsensusModule.Context aeronDirectoryName(String aeronDirectoryName)
```
    Set the top level Aeron directory used for communication between the Aeron client and Media Driver.
    
    Parameters:
    
    aeronDirectoryName - the top level Aeron directory.
    
    Returns:
    
    this for a fluent API.
  - aeronDirectoryName
```
public String aeronDirectoryName()
```
    Get the top level Aeron directory used for communication between the Aeron client and Media Driver.
    
    Returns:
    
    The top level Aeron directory.
  - ownsAeronClient
```
public ConsensusModule.Context ownsAeronClient(boolean ownsAeronClient)
```
    Does this context own the aeron() client and this takes responsibility for closing it?
    
    Parameters:
    
    ownsAeronClient - does this context own the aeron() client.
    
    Returns:
    
    this for a fluent API.
  - ownsAeronClient
```
public boolean ownsAeronClient()
```
    Does this context own the aeron() client and this takes responsibility for closing it?
    
    Returns:
    
    does this context own the aeron() client and this takes responsibility for closing it?
  - archiveContext
```
public ConsensusModule.Context archiveContext(AeronArchive.Context archiveContext)
```
    Set the AeronArchive.Context that should be used for communicating with the local Archive.
    
    Parameters:
    
    archiveContext - that should be used for communicating with the local Archive.
    
    Returns:
    
    this for a fluent API.
  - archiveContext
```
public AeronArchive.Context archiveContext()
```
    Get the AeronArchive.Context that should be used for communicating with the local Archive.
    
    Returns:
    
    the AeronArchive.Context that should be used for communicating with the local Archive.
  - authenticatorSupplier
```
public AuthenticatorSupplier authenticatorSupplier()
```
    Get the AuthenticatorSupplier that should be used for the consensus module.
    
    Returns:
    
    the AuthenticatorSupplier to be used for the consensus module.
  - authenticatorSupplier
```
public ConsensusModule.Context authenticatorSupplier(AuthenticatorSupplier authenticatorSupplier)
```
    Set the AuthenticatorSupplier that will be used for the consensus module.
    
    Parameters:
    
    authenticatorSupplier - AuthenticatorSupplier to use for the consensus module.
    
    Returns:
    
    this for a fluent API.
  - shutdownSignalBarrier
```
public ConsensusModule.Context shutdownSignalBarrier(ShutdownSignalBarrier barrier)
```
    Set the ShutdownSignalBarrier that can be used to shutdown a consensus module.
    
    Parameters:
    
    barrier - that can be used to shutdown a consensus module.
    
    Returns:
    
    this for a fluent API.
  - shutdownSignalBarrier
```
public ShutdownSignalBarrier shutdownSignalBarrier()
```
    Get the ShutdownSignalBarrier that can be used to shutdown a consensus module.
    
    Returns:
    
    the ShutdownSignalBarrier that can be used to shutdown a consensus module.
  - terminationHook
```
public ConsensusModule.Context terminationHook(Runnable terminationHook)
```
    Set the Runnable that is called when the ConsensusModule processes a termination action.
    
    Parameters:
    
    terminationHook - that can be used to terminate a consensus module.
    
    Returns:
    
    this for a fluent API.
  - terminationHook
```
public Runnable terminationHook()
```
    Get the Runnable that is called when the ConsensusModule processes a termination action.
    The default action is to call signal on the shutdownSignalBarrier().
    
    Returns:
    
    the Runnable that can be used to terminate a consensus module.
  - clusterMarkFile
```
public ConsensusModule.Context clusterMarkFile(ClusterMarkFile markFile)
```
    Set the ClusterMarkFile in use.
    
    Parameters:
    
    markFile - to use.
    
    Returns:
    
    this for a fluent API.
  - clusterMarkFile
```
public ClusterMarkFile clusterMarkFile()
```
    The ClusterMarkFile in use.
    
    Returns:
    
    ClusterMarkFile in use.
  - errorBufferLength
```
public ConsensusModule.Context errorBufferLength(int errorBufferLength)
```
    Set the error buffer length in bytes to use.
    
    Parameters:
    
    errorBufferLength - in bytes to use.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ConsensusModule.Configuration.ERROR_BUFFER_LENGTH_PROP_NAME
  - errorBufferLength
```
public int errorBufferLength()
```
    The error buffer length in bytes.
    
    Returns:
    
    error buffer length in bytes.
    
    See Also:
    
    ConsensusModule.Configuration.ERROR_BUFFER_LENGTH_PROP_NAME
  - errorLog
```
public ConsensusModule.Context errorLog(DistinctErrorLog errorLog)
```
    Set the DistinctErrorLog in use.
    
    Parameters:
    
    errorLog - to use.
    
    Returns:
    
    this for a fluent API.
  - errorLog
```
public DistinctErrorLog errorLog()
```
    The DistinctErrorLog in use.
    
    Returns:
    
    DistinctErrorLog in use.
  - random
```
public ConsensusModule.Context random(Random random)
```
    The source of random values for timeouts used in elections.
    
    Parameters:
    
    random - source of random values for timeouts used in elections.
    
    Returns:
    
    this for a fluent API.
  - random
```
public Random random()
```
    The source of random values for timeouts used in elections.
    
    Returns:
    
    source of random values for timeouts used in elections.
  - deleteDirectory
```
public void deleteDirectory()
```
    Delete the cluster directory.
  - close
```
public void close()
```
    Close the context and free applicable resources.
    If ownsAeronClient() is true then the aeron() client will be closed.

Class ConsensusModule.Context

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Context

Method Detail

clone

conclude

deleteDirOnStart

deleteDirOnStart

clusterDirectoryName

clusterDirectoryName

clusterDir

clusterDir

recordingLog

recordingLog

appVersion

appVersion

fileSyncLevel

clusterId

clusterId

clusterMemberId

clusterMemberId

appointedLeaderId

appointedLeaderId

clusterMembers

clusterMembers

clusterConsensusEndpoints

clusterConsensusEndpoints

clusterMembersIgnoreSnapshot

clusterMembersIgnoreSnapshot

ingressChannel

ingressChannel

ingressStreamId

ingressStreamId

ingressFragmentLimit

ingressFragmentLimit

logChannel

logChannel

logStreamId

logStreamId

memberEndpoints

memberEndpoints

replayChannel

replayChannel

replayStreamId

replayStreamId

controlChannel

controlChannel

serviceStreamId

serviceStreamId

consensusModuleStreamId

consensusModuleStreamId

snapshotChannel

snapshotChannel

snapshotStreamId

snapshotStreamId

consensusChannel

consensusChannel

consensusStreamId

consensusStreamId

logFragmentLimit

logFragmentLimit

wheelTickResolutionNs

wheelTickResolutionNs

ticksPerWheel

ticksPerWheel

serviceCount

serviceCount

maxConcurrentSessions

maxConcurrentSessions

sessionTimeoutNs

sessionTimeoutNs

leaderHeartbeatTimeoutNs

leaderHeartbeatTimeoutNs

leaderHeartbeatIntervalNs

leaderHeartbeatIntervalNs

startupCanvassTimeoutNs

startupCanvassTimeoutNs