AeronArchive.Configuration (Aeron Message Transport)

java.lang.Object
- io.aeron.archive.client.AeronArchive.Configuration

Enclosing class:

AeronArchive
```
public static final class AeronArchive.Configuration
extends Object
```
Common configuration properties for communicating with an Aeron archive.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONTROL_CHANNEL_DEFAULT` Channel for sending control messages to an archive.
`static String`	`CONTROL_CHANNEL_PROP_NAME` Channel for sending control messages to an archive.
`static int`	`CONTROL_MTU_LENGTH_DEFAULT` MTU to reflect default for the control streams.
`static String`	`CONTROL_MTU_LENGTH_PROP_NAME` MTU length for control streams.
`static String`	`CONTROL_RESPONSE_CHANNEL_DEFAULT` Default channel for receiving control response messages from an archive.
`static String`	`CONTROL_RESPONSE_CHANNEL_PROP_NAME` Channel for receiving control response messages from an archive.
`static int`	`CONTROL_RESPONSE_STREAM_ID_DEFAULT` Stream id within a channel for receiving control messages from an archive.
`static String`	`CONTROL_RESPONSE_STREAM_ID_PROP_NAME` Stream id within a channel for receiving control messages from an archive.
`static int`	`CONTROL_STREAM_ID_DEFAULT` Stream id within a channel for sending control messages to an archive.
`static String`	`CONTROL_STREAM_ID_PROP_NAME` Stream id within a channel for sending control messages to an archive.
`static int`	`CONTROL_TERM_BUFFER_LENGTH_DEFAULT` Low term length for control channel reflects expected low bandwidth usage.
`static String`	`CONTROL_TERM_BUFFER_LENGTH_PROP_NAME` Term length for control streams.
`static boolean`	`CONTROL_TERM_BUFFER_SPARSE_DEFAULT` Overrides `Configuration.TERM_BUFFER_SPARSE_FILE_PROP_NAME` for if term buffer files are sparse on the control channel.
`static String`	`CONTROL_TERM_BUFFER_SPARSE_PROP_NAME` Sparse term buffer indicator for control streams.
`static String`	`LOCAL_CONTROL_CHANNEL_DEFAULT` Channel for sending control messages to a driver local archive.
`static String`	`LOCAL_CONTROL_CHANNEL_PROP_NAME` Channel for sending control messages to a driver local archive.
`static int`	`LOCAL_CONTROL_STREAM_ID_DEFAULT` Stream id within a channel for sending control messages to a driver local archive.
`static String`	`LOCAL_CONTROL_STREAM_ID_PROP_NAME` Stream id within a channel for sending control messages to a driver local archive.
`static long`	`MESSAGE_TIMEOUT_DEFAULT_NS` Timeout when waiting on a message to be sent or received.
`static String`	`MESSAGE_TIMEOUT_PROP_NAME` Timeout in nanoseconds when waiting on a message to be sent or received.
`static int`	`PROTOCOL_MAJOR_VERSION` Major version of the network protocol from client to archive.
`static int`	`PROTOCOL_MINOR_VERSION` Minor version of the network protocol from client to archive.
`static int`	`PROTOCOL_PATCH_VERSION` Patch version of the network protocol from client to archive.
`static int`	`PROTOCOL_SEMANTIC_VERSION` Combined semantic version for the archive control protocol.
`static String`	`RECORDING_EVENTS_CHANNEL_DEFAULT` Channel for receiving progress events of recordings from an archive.
`static String`	`RECORDING_EVENTS_CHANNEL_PROP_NAME` Channel for receiving progress events of recordings from an archive.
`static boolean`	`RECORDING_EVENTS_ENABLED_DEFAULT` Channel enabled for recording progress events of recordings from an archive which defaults to true.
`static String`	`RECORDING_EVENTS_ENABLED_PROP_NAME` Is channel enabled for recording progress events of recordings from an archive.
`static int`	`RECORDING_EVENTS_STREAM_ID_DEFAULT` Stream id within a channel for receiving progress of recordings from an archive.
`static String`	`RECORDING_EVENTS_STREAM_ID_PROP_NAME` Stream id within a channel for receiving progress of recordings from an archive.

Constructor Summary

Constructors
Constructor and Description

Configuration()

Constructors
Constructor and Description
`Configuration()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`controlChannel()` The value `CONTROL_CHANNEL_DEFAULT` or system property `CONTROL_CHANNEL_PROP_NAME` if set.
`static int`	`controlMtuLength()` MTU length to be used for control request and response streams.
`static String`	`controlResponseChannel()` The value `CONTROL_RESPONSE_CHANNEL_DEFAULT` or system property `CONTROL_RESPONSE_CHANNEL_PROP_NAME` if set.
`static int`	`controlResponseStreamId()` The value `CONTROL_RESPONSE_STREAM_ID_DEFAULT` or system property `CONTROL_RESPONSE_STREAM_ID_PROP_NAME` if set.
`static int`	`controlStreamId()` The value `CONTROL_STREAM_ID_DEFAULT` or system property `CONTROL_STREAM_ID_PROP_NAME` if set.
`static int`	`controlTermBufferLength()` Term buffer length to be used for control request and response streams.
`static boolean`	`controlTermBufferSparse()` Should term buffer files be sparse for control request and response streams.
`static String`	`localControlChannel()` The value `LOCAL_CONTROL_CHANNEL_DEFAULT` or system property `LOCAL_CONTROL_CHANNEL_PROP_NAME` if set.
`static int`	`localControlStreamId()` The value `LOCAL_CONTROL_STREAM_ID_DEFAULT` or system property `LOCAL_CONTROL_STREAM_ID_PROP_NAME` if set.
`static long`	`messageTimeoutNs()` The timeout in nanoseconds to wait for a message.
`static String`	`recordingEventsChannel()` The value `RECORDING_EVENTS_CHANNEL_DEFAULT` or system property `RECORDING_EVENTS_CHANNEL_PROP_NAME` if set.
`static boolean`	`recordingEventsEnabled()` Should the recording events stream be enabled.
`static int`	`recordingEventsStreamId()` The value `RECORDING_EVENTS_STREAM_ID_DEFAULT` or system property `RECORDING_EVENTS_STREAM_ID_PROP_NAME` if set.

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

- Field Detail
  - PROTOCOL_MAJOR_VERSION
```
public static final int PROTOCOL_MAJOR_VERSION
```
    Major version of the network protocol from client to archive. If these don't match then client and archive are not compatible.
    
    See Also:
    
    Constant Field Values
  - PROTOCOL_MINOR_VERSION
```
public static final int PROTOCOL_MINOR_VERSION
```
    Minor version of the network protocol from client to archive. If these don't match then some features may not be available.
    
    See Also:
    
    Constant Field Values
  - PROTOCOL_PATCH_VERSION
```
public static final int PROTOCOL_PATCH_VERSION
```
    Patch version of the network protocol from client to archive. If these don't match then bug fixes may not have been applied.
    
    See Also:
    
    Constant Field Values
  - PROTOCOL_SEMANTIC_VERSION
```
public static final int PROTOCOL_SEMANTIC_VERSION
```
    Combined semantic version for the archive control protocol.
    
    See Also:
    
    SemanticVersion
  - MESSAGE_TIMEOUT_PROP_NAME
```
public static final String MESSAGE_TIMEOUT_PROP_NAME
```
    Timeout in nanoseconds when waiting on a message to be sent or received.
    
    See Also:
    
    Constant Field Values
  - MESSAGE_TIMEOUT_DEFAULT_NS
```
public static final long MESSAGE_TIMEOUT_DEFAULT_NS
```
    Timeout when waiting on a message to be sent or received.
  - CONTROL_CHANNEL_PROP_NAME
```
public static final String CONTROL_CHANNEL_PROP_NAME
```
    Channel for sending control messages to an archive.
    
    See Also:
    
    Constant Field Values
  - CONTROL_CHANNEL_DEFAULT
```
public static final String CONTROL_CHANNEL_DEFAULT
```
    Channel for sending control messages to an archive.
    
    See Also:
    
    Constant Field Values
  - CONTROL_STREAM_ID_PROP_NAME
```
public static final String CONTROL_STREAM_ID_PROP_NAME
```
    Stream id within a channel for sending control messages to an archive.
    
    See Also:
    
    Constant Field Values
  - CONTROL_STREAM_ID_DEFAULT
```
public static final int CONTROL_STREAM_ID_DEFAULT
```
    Stream id within a channel for sending control messages to an archive.
    
    See Also:
    
    Constant Field Values
  - LOCAL_CONTROL_CHANNEL_PROP_NAME
```
public static final String LOCAL_CONTROL_CHANNEL_PROP_NAME
```
    Channel for sending control messages to a driver local archive.
    
    See Also:
    
    Constant Field Values
  - LOCAL_CONTROL_CHANNEL_DEFAULT
```
public static final String LOCAL_CONTROL_CHANNEL_DEFAULT
```
    Channel for sending control messages to a driver local archive. Default to IPC.
    
    See Also:
    
    Constant Field Values
  - LOCAL_CONTROL_STREAM_ID_PROP_NAME
```
public static final String LOCAL_CONTROL_STREAM_ID_PROP_NAME
```
    Stream id within a channel for sending control messages to a driver local archive.
    
    See Also:
    
    Constant Field Values
  - LOCAL_CONTROL_STREAM_ID_DEFAULT
```
public static final int LOCAL_CONTROL_STREAM_ID_DEFAULT
```
    Stream id within a channel for sending control messages to a driver local archive.
    
    See Also:
    
    Constant Field Values
  - CONTROL_RESPONSE_CHANNEL_PROP_NAME
```
public static final String CONTROL_RESPONSE_CHANNEL_PROP_NAME
```
    Channel for receiving control response messages from an archive.
    Channel's endpoint can be specified explicitly (i.e. by providing address and port pair) or by using zero as a port number. Here is an example of valid response channels:
    - aeron:udp?endpoint=localhost:8020 - listen on port 8020 on localhost.
    - aeron:udp?endpoint=192.168.10.10:8020 - listen on port 8020 on 192.168.10.10.
    - aeron:udp?endpoint=localhost:0 - in this case the port is unspecified and the OS will assign a free port from the ephemeral port range.
    See Also:
    
    Constant Field Values
  - CONTROL_RESPONSE_CHANNEL_DEFAULT
```
public static final String CONTROL_RESPONSE_CHANNEL_DEFAULT
```
    Default channel for receiving control response messages from an archive.
    
    See Also:
    
    Constant Field Values
  - CONTROL_RESPONSE_STREAM_ID_PROP_NAME
```
public static final String CONTROL_RESPONSE_STREAM_ID_PROP_NAME
```
    Stream id within a channel for receiving control messages from an archive.
    
    See Also:
    
    Constant Field Values
  - CONTROL_RESPONSE_STREAM_ID_DEFAULT
```
public static final int CONTROL_RESPONSE_STREAM_ID_DEFAULT
```
    Stream id within a channel for receiving control messages from an archive.
    
    See Also:
    
    Constant Field Values
  - RECORDING_EVENTS_CHANNEL_PROP_NAME
```
public static final String RECORDING_EVENTS_CHANNEL_PROP_NAME
```
    Channel for receiving progress events of recordings from an archive.
    
    See Also:
    
    Constant Field Values
  - RECORDING_EVENTS_CHANNEL_DEFAULT
```
public static final String RECORDING_EVENTS_CHANNEL_DEFAULT
```
    Channel for receiving progress events of recordings from an archive. For production it is recommended that multicast or dynamic multi-destination-cast (MDC) is used to allow for dynamic subscribers, an endpoint can be added to the subscription side for controlling port usage.
    
    See Also:
    
    Constant Field Values
  - RECORDING_EVENTS_STREAM_ID_PROP_NAME
```
public static final String RECORDING_EVENTS_STREAM_ID_PROP_NAME
```
    Stream id within a channel for receiving progress of recordings from an archive.
    
    See Also:
    
    Constant Field Values
  - RECORDING_EVENTS_STREAM_ID_DEFAULT
```
public static final int RECORDING_EVENTS_STREAM_ID_DEFAULT
```
    Stream id within a channel for receiving progress of recordings from an archive.
    
    See Also:
    
    Constant Field Values
  - RECORDING_EVENTS_ENABLED_PROP_NAME
```
public static final String RECORDING_EVENTS_ENABLED_PROP_NAME
```
    Is channel enabled for recording progress events of recordings from an archive.
    
    See Also:
    
    Constant Field Values
  - RECORDING_EVENTS_ENABLED_DEFAULT
```
public static final boolean RECORDING_EVENTS_ENABLED_DEFAULT
```
    Channel enabled for recording progress events of recordings from an archive which defaults to true.
    
    See Also:
    
    Constant Field Values
  - CONTROL_TERM_BUFFER_SPARSE_PROP_NAME
```
public static final String CONTROL_TERM_BUFFER_SPARSE_PROP_NAME
```
    Sparse term buffer indicator for control streams.
    
    See Also:
    
    Constant Field Values
  - CONTROL_TERM_BUFFER_SPARSE_DEFAULT
```
public static final boolean CONTROL_TERM_BUFFER_SPARSE_DEFAULT
```
    Overrides Configuration.TERM_BUFFER_SPARSE_FILE_PROP_NAME for if term buffer files are sparse on the control channel.
    
    See Also:
    
    Constant Field Values
  - CONTROL_TERM_BUFFER_LENGTH_PROP_NAME
```
public static final String CONTROL_TERM_BUFFER_LENGTH_PROP_NAME
```
    Term length for control streams.
    
    See Also:
    
    Constant Field Values
  - CONTROL_TERM_BUFFER_LENGTH_DEFAULT
```
public static final int CONTROL_TERM_BUFFER_LENGTH_DEFAULT
```
    Low term length for control channel reflects expected low bandwidth usage.
    
    See Also:
    
    Constant Field Values
  - CONTROL_MTU_LENGTH_PROP_NAME
```
public static final String CONTROL_MTU_LENGTH_PROP_NAME
```
    MTU length for control streams.
    
    See Also:
    
    Constant Field Values
  - CONTROL_MTU_LENGTH_DEFAULT
```
public static final int CONTROL_MTU_LENGTH_DEFAULT
```
    MTU to reflect default for the control streams.
- Constructor Detail
  - Configuration
```
public Configuration()
```
- Method Detail
  - messageTimeoutNs
```
public static long messageTimeoutNs()
```
    The timeout in nanoseconds to wait for a message.
    
    Returns:
    
    timeout in nanoseconds to wait for a message.
    
    See Also:
    
    MESSAGE_TIMEOUT_PROP_NAME
  - controlTermBufferSparse
```
public static boolean controlTermBufferSparse()
```
    Should term buffer files be sparse for control request and response streams.
    
    Returns:
    
    true if term buffer files should be sparse for control request and response streams.
    
    See Also:
    
    CONTROL_TERM_BUFFER_SPARSE_PROP_NAME
  - controlTermBufferLength
```
public static int controlTermBufferLength()
```
    Term buffer length to be used for control request and response streams.
    
    Returns:
    
    term buffer length to be used for control request and response streams.
    
    See Also:
    
    CONTROL_TERM_BUFFER_LENGTH_PROP_NAME
  - controlMtuLength
```
public static int controlMtuLength()
```
    MTU length to be used for control request and response streams.
    
    Returns:
    
    MTU length to be used for control request and response streams.
    
    See Also:
    
    CONTROL_MTU_LENGTH_PROP_NAME
  - controlChannel
```
public static String controlChannel()
```
    The value CONTROL_CHANNEL_DEFAULT or system property CONTROL_CHANNEL_PROP_NAME if set.
    
    Returns:
    
    CONTROL_CHANNEL_DEFAULT or system property CONTROL_CHANNEL_PROP_NAME if set.
  - controlStreamId
```
public static int controlStreamId()
```
    The value CONTROL_STREAM_ID_DEFAULT or system property CONTROL_STREAM_ID_PROP_NAME if set.
    
    Returns:
    
    CONTROL_STREAM_ID_DEFAULT or system property CONTROL_STREAM_ID_PROP_NAME if set.
  - localControlChannel
```
public static String localControlChannel()
```
    The value LOCAL_CONTROL_CHANNEL_DEFAULT or system property LOCAL_CONTROL_CHANNEL_PROP_NAME if set.
    
    Returns:
    
    LOCAL_CONTROL_CHANNEL_DEFAULT or system property LOCAL_CONTROL_CHANNEL_PROP_NAME if set.
  - localControlStreamId
```
public static int localControlStreamId()
```
    The value LOCAL_CONTROL_STREAM_ID_DEFAULT or system property LOCAL_CONTROL_STREAM_ID_PROP_NAME if set.
    
    Returns:
    
    LOCAL_CONTROL_STREAM_ID_DEFAULT or system property LOCAL_CONTROL_STREAM_ID_PROP_NAME if set.
  - controlResponseChannel
```
public static String controlResponseChannel()
```
    The value CONTROL_RESPONSE_CHANNEL_DEFAULT or system property CONTROL_RESPONSE_CHANNEL_PROP_NAME if set.
    
    Returns:
    
    CONTROL_RESPONSE_CHANNEL_DEFAULT or system property CONTROL_RESPONSE_CHANNEL_PROP_NAME if set.
  - controlResponseStreamId
```
public static int controlResponseStreamId()
```
    The value CONTROL_RESPONSE_STREAM_ID_DEFAULT or system property CONTROL_RESPONSE_STREAM_ID_PROP_NAME if set.
    
    Returns:
    
    CONTROL_RESPONSE_STREAM_ID_DEFAULT or system property CONTROL_RESPONSE_STREAM_ID_PROP_NAME if set.
  - recordingEventsChannel
```
public static String recordingEventsChannel()
```
    The value RECORDING_EVENTS_CHANNEL_DEFAULT or system property RECORDING_EVENTS_CHANNEL_PROP_NAME if set.
    
    Returns:
    
    RECORDING_EVENTS_CHANNEL_DEFAULT or system property RECORDING_EVENTS_CHANNEL_PROP_NAME if set.
  - recordingEventsStreamId
```
public static int recordingEventsStreamId()
```
    The value RECORDING_EVENTS_STREAM_ID_DEFAULT or system property RECORDING_EVENTS_STREAM_ID_PROP_NAME if set.
    
    Returns:
    
    RECORDING_EVENTS_STREAM_ID_DEFAULT or system property RECORDING_EVENTS_STREAM_ID_PROP_NAME if set.
  - recordingEventsEnabled
```
public static boolean recordingEventsEnabled()
```
    Should the recording events stream be enabled.
    
    Returns:
    
    true if the recording events stream be enabled.
    
    See Also:
    
    RECORDING_EVENTS_ENABLED_PROP_NAME

Class AeronArchive.Configuration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROTOCOL_MAJOR_VERSION

PROTOCOL_MINOR_VERSION

PROTOCOL_PATCH_VERSION

PROTOCOL_SEMANTIC_VERSION

MESSAGE_TIMEOUT_PROP_NAME

MESSAGE_TIMEOUT_DEFAULT_NS

CONTROL_CHANNEL_PROP_NAME

CONTROL_CHANNEL_DEFAULT

CONTROL_STREAM_ID_PROP_NAME

CONTROL_STREAM_ID_DEFAULT

LOCAL_CONTROL_CHANNEL_PROP_NAME

LOCAL_CONTROL_CHANNEL_DEFAULT

LOCAL_CONTROL_STREAM_ID_PROP_NAME

LOCAL_CONTROL_STREAM_ID_DEFAULT

CONTROL_RESPONSE_CHANNEL_PROP_NAME

CONTROL_RESPONSE_CHANNEL_DEFAULT

CONTROL_RESPONSE_STREAM_ID_PROP_NAME

CONTROL_RESPONSE_STREAM_ID_DEFAULT

RECORDING_EVENTS_CHANNEL_PROP_NAME

RECORDING_EVENTS_CHANNEL_DEFAULT

RECORDING_EVENTS_STREAM_ID_PROP_NAME

RECORDING_EVENTS_STREAM_ID_DEFAULT

RECORDING_EVENTS_ENABLED_PROP_NAME

RECORDING_EVENTS_ENABLED_DEFAULT

CONTROL_TERM_BUFFER_SPARSE_PROP_NAME

CONTROL_TERM_BUFFER_SPARSE_DEFAULT

CONTROL_TERM_BUFFER_LENGTH_PROP_NAME

CONTROL_TERM_BUFFER_LENGTH_DEFAULT

CONTROL_MTU_LENGTH_PROP_NAME

CONTROL_MTU_LENGTH_DEFAULT

Constructor Detail

Configuration

Method Detail

messageTimeoutNs

controlTermBufferSparse

controlTermBufferLength

controlMtuLength

controlChannel

controlStreamId

localControlChannel

localControlStreamId

controlResponseChannel

controlResponseStreamId

recordingEventsChannel

recordingEventsStreamId

recordingEventsEnabled