ClusteredServiceContainer.Context (Aeron Message Transport)

java.lang.Object
- io.aeron.cluster.service.ClusteredServiceContainer.Context

All Implemented Interfaces:

Cloneable

Enclosing class:

ClusteredServiceContainer
```
public static final class ClusteredServiceContainer.Context
extends Object
implements Cloneable
```
The context will be owned by ClusteredServiceAgent after a successful ClusteredServiceContainer.launch(Context) and closed via ClusteredServiceContainer.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()` An `Aeron` client for the container.
`ClusteredServiceContainer.Context`	`aeron(Aeron aeron)` Provide an `Aeron` client for the container
`String`	`aeronDirectoryName()` Get the top level Aeron directory used for communication between the Aeron client and Media Driver.
`ClusteredServiceContainer.Context`	`aeronDirectoryName(String aeronDirectoryName)` Set the top level Aeron directory used for communication between the Aeron client and Media Driver.
`int`	`appVersion()` User assigned application version which appended to the log as the appVersion in new leadership events.
`ClusteredServiceContainer.Context`	`appVersion(int appVersion)` User assigned application version which appended to the log as the appVersion in new leadership events.
`AppVersionValidator`	`appVersionValidator()` User assigned application version validator implementation used to check version compatibility.
`ClusteredServiceContainer.Context`	`appVersionValidator(AppVersionValidator appVersionValidator)` User assigned application version validator implementation used to check version compatibility.
`AeronArchive.Context`	`archiveContext()` Get the context that should be used for communicating with the local Archive.
`ClusteredServiceContainer.Context`	`archiveContext(AeronArchive.Context archiveContext)` Set the context that should be used for communicating with the local Archive.
`ClusteredServiceContainer.Context`	`clone()` Perform a shallow copy of the object.
`void`	`close()` Close the context and free applicable resources.
`File`	`clusterDir()` The directory used for the cluster directory.
`ClusteredServiceContainer.Context`	`clusterDir(File clusterDir)` Set the directory to use for the cluster directory.
`String`	`clusterDirectoryName()` The directory name to use for the cluster directory.
`ClusteredServiceContainer.Context`	`clusterDirectoryName(String clusterDirectoryName)` Set the directory name to use for the consensus module directory.
`ClusteredService`	`clusteredService()` The service this container holds.
`ClusteredServiceContainer.Context`	`clusteredService(ClusteredService clusteredService)` Set the service this container is to hold.
`int`	`clusterId()` Get the id for this cluster instance.
`ClusteredServiceContainer.Context`	`clusterId(int clusterId)` Set the id for this cluster instance.
`ClusterMarkFile`	`clusterMarkFile()` The `ClusterMarkFile` in use.
`ClusteredServiceContainer.Context`	`clusterMarkFile(ClusterMarkFile markFile)` Set the `ClusterMarkFile` in use.
`void`	`conclude()` Conclude configuration by setting up defaults when specifics are not provided.
`int`	`consensusModuleStreamId()` Get the stream id for communications from the services to the consensus module.
`ClusteredServiceContainer.Context`	`consensusModuleStreamId(int streamId)` Set the stream id for communications from the services to the consensus module.
`String`	`controlChannel()` Get the channel parameter for bidirectional communications between the consensus module and services.
`ClusteredServiceContainer.Context`	`controlChannel(String channel)` Set the channel parameter for bidirectional communications between the consensus module and services.
`CountedErrorHandler`	`countedErrorHandler()` The `errorHandler()` that will increment `errorCounter()` by default.
`ClusteredServiceContainer.Context`	`countedErrorHandler(CountedErrorHandler countedErrorHandler)` Non-default for context.
`long`	`cycleThresholdNs()` Threshold for the container work cycle time which when exceed it will increment the counter.
`ClusteredServiceContainer.Context`	`cycleThresholdNs(long thresholdNs)` Set a threshold for the container work cycle time which when exceed it will increment the counter.
`DelegatingErrorHandler`	`delegatingErrorHandler()` Get the `DelegatingErrorHandler` to be used by the `ClusteredServiceContainer` which will delegate to `errorHandler()` as next in the chain.
`ClusteredServiceContainer.Context`	`delegatingErrorHandler(DelegatingErrorHandler delegatingErrorHandler)` Set the `DelegatingErrorHandler` to be used by the `ClusteredServiceContainer` which will delegate to `errorHandler()` as next in the chain.
`void`	`deleteDirectory()` Delete the cluster container directory.
`DutyCycleTracker`	`dutyCycleTracker()` The duty cycle tracker used to track the container duty cycle.
`ClusteredServiceContainer.Context`	`dutyCycleTracker(DutyCycleTracker dutyCycleTracker)` Set a duty cycle tracker to be used for tracking the duty cycle time of the container.
`EpochClock`	`epochClock()` Get the `EpochClock` to used for tracking wall clock time within the container.
`ClusteredServiceContainer.Context`	`epochClock(EpochClock clock)` Set the `EpochClock` to be used for tracking wall clock time when interacting with the container.
`int`	`errorBufferLength()` The error buffer length in bytes.
`ClusteredServiceContainer.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 the container has observed.
`ClusteredServiceContainer.Context`	`errorCounter(AtomicCounter errorCounter)` Set the error counter that will record the number of errors the cluster node has observed.
`ErrorHandler`	`errorHandler()` Get the `ErrorHandler` to be used by the `ClusteredServiceContainer`.
`ClusteredServiceContainer.Context`	`errorHandler(ErrorHandler errorHandler)` Set the `ErrorHandler` to be used by the `ClusteredServiceContainer`.
`DistinctErrorLog`	`errorLog()` The `DistinctErrorLog` in use.
`ClusteredServiceContainer.Context`	`errorLog(DistinctErrorLog errorLog)` Set the `DistinctErrorLog` in use.
`IdleStrategy`	`idleStrategy()` Get a new `IdleStrategy` based on configured supplier.
`ClusteredServiceContainer.Context`	`idleStrategySupplier(Supplier<IdleStrategy> idleStrategySupplier)` Provides an `IdleStrategy` supplier for the idle strategy for the agent duty cycle.
`boolean`	`isRespondingService()` Is this a service that responds to client requests?
`ClusteredServiceContainer.Context`	`isRespondingService(boolean isRespondingService)` Set if this a service that responds to client requests.
`int`	`logFragmentLimit()` Get the fragment limit to be used when polling the log `Subscription`.
`ClusteredServiceContainer.Context`	`logFragmentLimit(int logFragmentLimit)` Set the fragment limit to be used when polling the log `Subscription`.
`File`	`markFileDir()` Get the directory in which the ClusteredServiceContainer will store mark file (i.e.
`ClusteredServiceContainer.Context`	`markFileDir(File markFileDir)` Set the directory in which the ClusteredServiceContainer will store mark file (i.e.
`NanoClock`	`nanoClock()` The `NanoClock` as a source of time in nanoseconds for measuring duration.
`ClusteredServiceContainer.Context`	`nanoClock(NanoClock clock)` The `NanoClock` as a source of time in nanoseconds for measuring duration.
`boolean`	`ownsAeronClient()` Does this context own the `aeron()` client and this takes responsibility for closing it?
`ClusteredServiceContainer.Context`	`ownsAeronClient(boolean ownsAeronClient)` Does this context own the `aeron()` client and this takes responsibility for closing it?
`String`	`replayChannel()` Get the channel parameter for the cluster log and snapshot replay channel.
`ClusteredServiceContainer.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.
`ClusteredServiceContainer.Context`	`replayStreamId(int streamId)` Set the stream id for the cluster log and snapshot replay channel.
`int`	`serviceId()` Get the id for this clustered service.
`ClusteredServiceContainer.Context`	`serviceId(int serviceId)` Set the id for this clustered service.
`String`	`serviceName()` Get the name for a clustered service to be the `Agent.roleName()` for the `Agent`.
`ClusteredServiceContainer.Context`	`serviceName(String serviceName)` Set the name for a clustered service to be the `Agent.roleName()` for the `Agent`.
`int`	`serviceStreamId()` Get the stream id for communications from the consensus module and to the services.
`ClusteredServiceContainer.Context`	`serviceStreamId(int streamId)` Set the stream id for communications from the consensus module and to the services.
`ShutdownSignalBarrier`	`shutdownSignalBarrier()` Get the `ShutdownSignalBarrier` that can be used to shut down a clustered service.
`ClusteredServiceContainer.Context`	`shutdownSignalBarrier(ShutdownSignalBarrier barrier)` Set the `ShutdownSignalBarrier` that can be used to shut down a clustered service.
`String`	`snapshotChannel()` Get the channel parameter for snapshot recordings.
`ClusteredServiceContainer.Context`	`snapshotChannel(String channel)` Set the channel parameter for snapshot recordings.
`int`	`snapshotStreamId()` Get the stream id for snapshot recordings.
`ClusteredServiceContainer.Context`	`snapshotStreamId(int streamId)` Set the stream id for snapshot recordings.
`boolean`	`standbySnapshotEnabled()` Indicates if this node should take standby snapshots
`ClusteredServiceContainer.Context`	`standbySnapshotEnabled(boolean standbySnapshotEnabled)` Indicates if this node should take standby snapshots
`Runnable`	`terminationHook()` Get the `Runnable` that is called when container is instructed to terminate.
`ClusteredServiceContainer.Context`	`terminationHook(Runnable terminationHook)` Set the `Runnable` that is called when container is instructed to terminate.
`ThreadFactory`	`threadFactory()` Get the thread factory used for creating threads.
`ClusteredServiceContainer.Context`	`threadFactory(ThreadFactory threadFactory)` Set the thread factory used for creating threads.
`String`	`toString()`

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

- Constructor Detail
  - Context
```
public Context()
```
- Method Detail
  - clone
```
public ClusteredServiceContainer.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.
  - appVersion
```
public ClusteredServiceContainer.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.
  - appVersionValidator
```
public ClusteredServiceContainer.Context appVersionValidator(AppVersionValidator appVersionValidator)
```
    User assigned application version validator implementation used to check version compatibility.
    The default validator uses SemanticVersion semantics.
    
    Parameters:
    
    appVersionValidator - for user application.
    
    Returns:
    
    this for fluent API.
  - appVersionValidator
```
public AppVersionValidator appVersionValidator()
```
    User assigned application version validator implementation used to check version compatibility.
    The default is to use SemanticVersion major version for checking compatibility.
    
    Returns:
    
    AppVersionValidator in use.
  - clusterId
```
public ClusteredServiceContainer.Context clusterId(int clusterId)
```
    Set the id for this cluster instance. This must match with the Consensus Module.
    
    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 Consensus Module.
    
    Returns:
    
    the id for this cluster instance.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CLUSTER_ID_PROP_NAME
  - serviceId
```
public ClusteredServiceContainer.Context serviceId(int serviceId)
```
    Set the id for this clustered service. Services should be numbered from 0 and be contiguous.
    
    Parameters:
    
    serviceId - for this clustered service.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ClusteredServiceContainer.Configuration.SERVICE_ID_PROP_NAME
  - serviceId
```
public int serviceId()
```
    Get the id for this clustered service. Services should be numbered from 0 and be contiguous.
    
    Returns:
    
    the id for this clustered service.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.SERVICE_ID_PROP_NAME
  - serviceName
```
public ClusteredServiceContainer.Context serviceName(String serviceName)
```
    Set the name for a clustered service to be the Agent.roleName() for the Agent.
    
    Parameters:
    
    serviceName - for a clustered service to be the role for the Agent.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.SERVICE_NAME_PROP_NAME
  - serviceName
```
public String serviceName()
```
    Get the name for a clustered service to be the Agent.roleName() for the Agent.
    
    Returns:
    
    the name for a clustered service to be the role of the Agent.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.SERVICE_NAME_PROP_NAME
  - replayChannel
```
public ClusteredServiceContainer.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 ClusteredServiceContainer.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 ClusteredServiceContainer.Context controlChannel(String channel)
```
    Set the channel parameter for bidirectional communications between the consensus module and services.
    
    Parameters:
    
    channel - parameter for sending messages to the Consensus Module.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CONTROL_CHANNEL_PROP_NAME
  - controlChannel
```
public String controlChannel()
```
    Get the channel parameter for bidirectional communications between the consensus module and services.
    
    Returns:
    
    the channel parameter for sending messages to the Consensus Module.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CONTROL_CHANNEL_PROP_NAME
  - serviceStreamId
```
public ClusteredServiceContainer.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 ClusteredServiceContainer.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 ClusteredServiceContainer.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 ClusteredServiceContainer.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
  - isRespondingService
```
public ClusteredServiceContainer.Context isRespondingService(boolean isRespondingService)
```
    Set if this a service that responds to client requests.
    
    Parameters:
    
    isRespondingService - true if this service responds to client requests, otherwise false.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.RESPONDER_SERVICE_PROP_NAME
  - logFragmentLimit
```
public ClusteredServiceContainer.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
  - isRespondingService
```
public boolean isRespondingService()
```
    Is this a service that responds to client requests?
    
    Returns:
    
    true if this service responds to client requests, otherwise false.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.RESPONDER_SERVICE_PROP_NAME
  - threadFactory
```
public ThreadFactory threadFactory()
```
    Get the thread factory used for creating threads.
    
    Returns:
    
    thread factory used for creating threads.
  - threadFactory
```
public ClusteredServiceContainer.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 ClusteredServiceContainer.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.
  - epochClock
```
public ClusteredServiceContainer.Context epochClock(EpochClock clock)
```
    Set the EpochClock to be used for tracking wall clock time when interacting with the container.
    
    Parameters:
    
    clock - EpochClock to be used for tracking wall clock time when interacting with the container.
    
    Returns:
    
    this for a fluent API.
  - epochClock
```
public EpochClock epochClock()
```
    Get the EpochClock to used for tracking wall clock time within the container.
    
    Returns:
    
    the EpochClock to used for tracking wall clock time within the container.
  - errorHandler
```
public ErrorHandler errorHandler()
```
    Get the ErrorHandler to be used by the ClusteredServiceContainer.
    
    Returns:
    
    the ErrorHandler to be used by the ClusteredServiceContainer.
  - errorHandler
```
public ClusteredServiceContainer.Context errorHandler(ErrorHandler errorHandler)
```
    Set the ErrorHandler to be used by the ClusteredServiceContainer.
    
    Parameters:
    
    errorHandler - the error handler to be used by the ClusteredServiceContainer.
    
    Returns:
    
    this for a fluent API
  - delegatingErrorHandler
```
public DelegatingErrorHandler delegatingErrorHandler()
```
    Get the DelegatingErrorHandler to be used by the ClusteredServiceContainer which will delegate to errorHandler() as next in the chain.
    
    Returns:
    
    the DelegatingErrorHandler to be used by the ClusteredServiceContainer.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.DELEGATING_ERROR_HANDLER_PROP_NAME
  - delegatingErrorHandler
```
public ClusteredServiceContainer.Context delegatingErrorHandler(DelegatingErrorHandler delegatingErrorHandler)
```
    Set the DelegatingErrorHandler to be used by the ClusteredServiceContainer which will delegate to errorHandler() as next in the chain.
    
    Parameters:
    
    delegatingErrorHandler - the error handler to be used by the ClusteredServiceContainer.
    
    Returns:
    
    this for a fluent API
    
    See Also:
    
    ClusteredServiceContainer.Configuration.DELEGATING_ERROR_HANDLER_PROP_NAME
  - errorCounter
```
public AtomicCounter errorCounter()
```
    Get the error counter that will record the number of errors the container has observed.
    
    Returns:
    
    the error counter that will record the number of errors the container has observed.
  - errorCounter
```
public ClusteredServiceContainer.Context errorCounter(AtomicCounter errorCounter)
```
    Set the error counter that will record the number of errors the cluster node has observed.
    
    Parameters:
    
    errorCounter - the error counter that will record the number of errors the cluster node has observed.
    
    Returns:
    
    this for a fluent API.
  - countedErrorHandler
```
public ClusteredServiceContainer.Context countedErrorHandler(CountedErrorHandler countedErrorHandler)
```
    Non-default for context.
    
    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.
  - aeronDirectoryName
```
public ClusteredServiceContainer.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.
  - aeron
```
public Aeron aeron()
```
    An Aeron client for the container.
    
    Returns:
    
    Aeron client for the container
  - aeron
```
public ClusteredServiceContainer.Context aeron(Aeron aeron)
```
    Provide an Aeron client for the container
    If not provided then one will be created.
    
    Parameters:
    
    aeron - client for the container
    
    Returns:
    
    this for a fluent API.
  - ownsAeronClient
```
public ClusteredServiceContainer.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?
  - clusteredService
```
public ClusteredService clusteredService()
```
    The service this container holds.
    
    Returns:
    
    service this container holds.
  - clusteredService
```
public ClusteredServiceContainer.Context clusteredService(ClusteredService clusteredService)
```
    Set the service this container is to hold.
    
    Parameters:
    
    clusteredService - this container is to hold.
    
    Returns:
    
    this for fluent API.
  - archiveContext
```
public ClusteredServiceContainer.Context archiveContext(AeronArchive.Context archiveContext)
```
    Set the 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 context that should be used for communicating with the local Archive.
    
    Returns:
    
    the context that should be used for communicating with the local Archive.
  - clusterDirectoryName
```
public ClusteredServiceContainer.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 cluster directory.
    
    Returns:
    
    directory name for the cluster directory.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CLUSTER_DIR_PROP_NAME
  - clusterDir
```
public ClusteredServiceContainer.Context clusterDir(File clusterDir)
```
    Set the directory to use for the cluster 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 the cluster directory.
    
    Returns:
    
    directory for the cluster directory.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CLUSTER_DIR_PROP_NAME
  - markFileDir
```
public File markFileDir()
```
    Get the directory in which the ClusteredServiceContainer will store mark file (i.e. cluster-mark-service-0.dat). It defaults to clusterDir() if it is not set explicitly via the ClusteredServiceContainer.Configuration.MARK_FILE_DIR_PROP_NAME.
    
    Returns:
    
    the directory in which the ClusteredServiceContainer will store mark file (i.e. cluster-mark-service-0.dat).
    
    See Also:
    
    ClusteredServiceContainer.Configuration.MARK_FILE_DIR_PROP_NAME, clusterDir()
  - markFileDir
```
public ClusteredServiceContainer.Context markFileDir(File markFileDir)
```
    Set the directory in which the ClusteredServiceContainer will store mark file (i.e. cluster-mark-service-0.dat).
    
    Parameters:
    
    markFileDir - the directory in which the ClusteredServiceContainer will store mark file (i.e. cluster-mark-service-0.dat).
    
    Returns:
    
    this for a fluent API.
  - shutdownSignalBarrier
```
public ClusteredServiceContainer.Context shutdownSignalBarrier(ShutdownSignalBarrier barrier)
```
    Set the ShutdownSignalBarrier that can be used to shut down a clustered service.
    
    Parameters:
    
    barrier - that can be used to shut down a clustered service.
    
    Returns:
    
    this for a fluent API.
  - shutdownSignalBarrier
```
public ShutdownSignalBarrier shutdownSignalBarrier()
```
    Get the ShutdownSignalBarrier that can be used to shut down a clustered service.
    
    Returns:
    
    the ShutdownSignalBarrier that can be used to shut down a clustered service.
  - terminationHook
```
public ClusteredServiceContainer.Context terminationHook(Runnable terminationHook)
```
    Set the Runnable that is called when container is instructed to terminate.
    
    Parameters:
    
    terminationHook - that can be used to terminate a service container.
    
    Returns:
    
    this for a fluent API.
  - terminationHook
```
public Runnable terminationHook()
```
    Get the Runnable that is called when container is instructed to terminate.
    The default action is to call signal on the shutdownSignalBarrier().
    
    Returns:
    
    the Runnable that can be used to terminate a service container.
  - clusterMarkFile
```
public ClusteredServiceContainer.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 ClusteredServiceContainer.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.
  - errorBufferLength
```
public int errorBufferLength()
```
    The error buffer length in bytes.
    
    Returns:
    
    error buffer length in bytes.
  - errorLog
```
public ClusteredServiceContainer.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.
  - nanoClock
```
public NanoClock nanoClock()
```
    The NanoClock as a source of time in nanoseconds for measuring duration.
    
    Returns:
    
    the NanoClock as a source of time in nanoseconds for measuring duration.
  - nanoClock
```
public ClusteredServiceContainer.Context nanoClock(NanoClock clock)
```
    The NanoClock as a source of time in nanoseconds for measuring duration.
    
    Parameters:
    
    clock - to be used.
    
    Returns:
    
    this for a fluent API.
  - cycleThresholdNs
```
public ClusteredServiceContainer.Context cycleThresholdNs(long thresholdNs)
```
    Set a threshold for the container work cycle time which when exceed it will increment the counter.
    
    Parameters:
    
    thresholdNs - value in nanoseconds
    
    Returns:
    
    this for fluent API.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.CYCLE_THRESHOLD_PROP_NAME, ClusteredServiceContainer.Configuration.CYCLE_THRESHOLD_DEFAULT_NS
  - cycleThresholdNs
```
public long cycleThresholdNs()
```
    Threshold for the container work cycle time which when exceed it will increment the counter.
    
    Returns:
    
    threshold to track for the container work cycle time.
  - dutyCycleTracker
```
public ClusteredServiceContainer.Context dutyCycleTracker(DutyCycleTracker dutyCycleTracker)
```
    Set a duty cycle tracker to be used for tracking the duty cycle time of the container.
    
    Parameters:
    
    dutyCycleTracker - to use for tracking.
    
    Returns:
    
    this for fluent API.
  - dutyCycleTracker
```
public DutyCycleTracker dutyCycleTracker()
```
    The duty cycle tracker used to track the container duty cycle.
    
    Returns:
    
    the duty cycle tracker.
  - deleteDirectory
```
public void deleteDirectory()
```
    Delete the cluster container directory.
  - standbySnapshotEnabled
```
public boolean standbySnapshotEnabled()
```
    Indicates if this node should take standby snapshots
    
    Returns:
    
    true if this should take standby snapshots, false otherwise.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.STANDBY_SNAPSHOT_ENABLED_PROP_NAME, ClusteredServiceContainer.Configuration.standbySnapshotEnabled()
  - standbySnapshotEnabled
```
public ClusteredServiceContainer.Context standbySnapshotEnabled(boolean standbySnapshotEnabled)
```
    Indicates if this node should take standby snapshots
    
    Parameters:
    
    standbySnapshotEnabled - if this node should take standby snapshots.
    
    Returns:
    
    this for a fluent API.
    
    See Also:
    
    ClusteredServiceContainer.Configuration.STANDBY_SNAPSHOT_ENABLED_PROP_NAME, ClusteredServiceContainer.Configuration.standbySnapshotEnabled()
  - close
```
public void close()
```
    Close the context and free applicable resources.
    If ownsAeronClient() is true then the aeron() client will be closed.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ClusteredServiceContainer.Context

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Context

Method Detail

clone

conclude

appVersion

appVersion

appVersionValidator

appVersionValidator

clusterId

clusterId

serviceId

serviceId

serviceName

serviceName

replayChannel

replayChannel

replayStreamId

replayStreamId

controlChannel

controlChannel

serviceStreamId

serviceStreamId

consensusModuleStreamId

consensusModuleStreamId

snapshotChannel

snapshotChannel

snapshotStreamId

snapshotStreamId

isRespondingService

logFragmentLimit

logFragmentLimit

isRespondingService

threadFactory

threadFactory

idleStrategySupplier

idleStrategy

epochClock

epochClock

errorHandler

errorHandler

delegatingErrorHandler

delegatingErrorHandler

errorCounter

errorCounter

countedErrorHandler

countedErrorHandler

aeronDirectoryName

aeronDirectoryName

aeron

aeron

ownsAeronClient

ownsAeronClient

clusteredService

clusteredService

archiveContext

archiveContext

clusterDirectoryName

clusterDirectoryName

clusterDir

clusterDir

markFileDir

markFileDir

shutdownSignalBarrier

shutdownSignalBarrier

terminationHook

terminationHook

clusterMarkFile

clusterMarkFile

errorBufferLength

errorBufferLength

errorLog

errorLog

nanoClock

nanoClock

cycleThresholdNs