Configuration (Aeron Transport Protocol)

java.lang.Object
- io.aeron.driver.Configuration

public class Configuration
extends java.lang.Object

Configuration options for the MediaDriver.

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`CLIENT_LIVENESS_TIMEOUT_DEFAULT_NS` Default timeout for client liveness in nanoseconds.
`static long`	`CLIENT_LIVENESS_TIMEOUT_NS` Timeout for client liveness in nanoseconds.
`static java.lang.String`	`CLIENT_LIVENESS_TIMEOUT_PROP_NAME` Property name for `Aeron` client liveness timeout.
`static int`	`CMD_QUEUE_CAPACITY` Capacity for the command queues used between driver agents.
`static int`	`CONDUCTOR_BUFFER_LENGTH` Conductor buffer length in bytes.
`static int`	`CONDUCTOR_BUFFER_LENGTH_DEFAULT` Default buffer length for conductor buffers between the client and the media driver conductor.
`static java.lang.String`	`CONDUCTOR_BUFFER_LENGTH_PROP_NAME` Length (in bytes) of the conductor buffer for control commands from the clients to the media driver conductor.
`static java.lang.String`	`CONDUCTOR_IDLE_STRATEGY` `IdleStrategy` to be employed by `DriverConductor` for `ThreadingMode.DEDICATED` and `ThreadingMode.SHARED_NETWORK`.
`static java.lang.String`	`CONDUCTOR_IDLE_STRATEGY_PROP_NAME` Property name for `IdleStrategy` to be employed by `DriverConductor` for `ThreadingMode.DEDICATED` and `ThreadingMode.SHARED_NETWORK`.
`static java.lang.String`	`CONGESTION_CONTROL_STRATEGY_SUPPLIER` `CongestionControlSupplier` to be employed for receivers.
`static java.lang.String`	`CONGESTION_CONTROL_STRATEGY_SUPPLIER_PROP_NAME` Property name for `CongestionControlSupplier` to be employed for receivers.
`static int`	`COUNTERS_METADATA_BUFFER_LENGTH`
`static int`	`COUNTERS_VALUES_BUFFER_LENGTH` Length of the memory mapped buffers for the system counters file.
`static int`	`COUNTERS_VALUES_BUFFER_LENGTH_DEFAULT` Default length of the memory mapped buffers for the system counters file.
`static java.lang.String`	`COUNTERS_VALUES_BUFFER_LENGTH_PROP_NAME` Property name for length of the error buffer for the system counters.
`static int`	`ERROR_BUFFER_LENGTH` Buffer length for the error buffer for the media driver.
`static int`	`ERROR_BUFFER_LENGTH_DEFAULT` Default buffer length for the error buffer for the media driver.
`static java.lang.String`	`ERROR_BUFFER_LENGTH_PROP_NAME` Property name for length of the memory mapped buffer for the distinct error log.
`static long`	`HEARTBEAT_TIMEOUT_NS` How often to check liveness and cleanup
`static long`	`IMAGE_LIVENESS_TIMEOUT_DEFAULT_NS` Default timeout for `Image` liveness in nanoseconds.
`static long`	`IMAGE_LIVENESS_TIMEOUT_NS` Timeout for `Image` liveness in nanoseconds.
`static java.lang.String`	`IMAGE_LIVENESS_TIMEOUT_PROP_NAME` Property name for `Image` liveness timeout.
`static int`	`INITIAL_WINDOW_LENGTH_DEFAULT` Default initial window length for flow control sender to receiver purposes Length of Initial Window RTT (LAN) = 100 usec Throughput = 10 Gbps Buffer = Throughput * RTT Buffer = (10 * 1000 * 1000 * 1000 / 8) * 0.0001 = 125000 Round to 128KB
`static java.lang.String`	`INITIAL_WINDOW_LENGTH_PROP_NAME` Property name for length of the initial window which must be sufficient for Bandwidth Delay Produce (BDP).
`static int`	`IPC_PUBLICATION_TERM_WINDOW_LENGTH` IPC Publication term window length for flow control in bytes.
`static java.lang.String`	`IPC_PUBLICATION_TERM_WINDOW_LENGTH_PROP_NAME` Property name for window limit for IPC publications.
`static int`	`IPC_TERM_BUFFER_LENGTH` IPC Term buffer length in bytes.
`static java.lang.String`	`IPC_TERM_BUFFER_LENGTH_PROP_NAME` Property name for term buffer length (in bytes) for IPC buffers.
`static int`	`LOSS_REPORT_BUFFER_LENGTH` Buffer length for the loss report buffer for the media driver.
`static int`	`LOSS_REPORT_BUFFER_LENGTH_DEFAULT` Default buffer length for the loss report buffer.
`static java.lang.String`	`LOSS_REPORT_BUFFER_LENGTH_PROP_NAME` Property name for length of the memory mapped buffer for the loss report buffer.
`static long`	`LOW_FILE_STORE_WARNING_THRESHOLD` Default value for low file storage warning threshold.
`static long`	`LOW_FILE_STORE_WARNING_THRESHOLD_DEFAULT` Default value for low file storage warning threshold.
`static java.lang.String`	`LOW_FILE_STORE_WARNING_THRESHOLD_PROP_NAME` Property name low file storage warning threshold.
`static int`	`MAX_RETRANSMITS_DEFAULT` Default max number of active retransmissions per connected stream.
`static int`	`MAX_UDP_PAYLOAD_LENGTH` Maximum UDP datagram payload size for IPv4.
`static int`	`MTU_LENGTH` Length of the MTU to use for sending messages.
`static int`	`MTU_LENGTH_DEFAULT` Default length is greater than typical Ethernet MTU so will fragment to save on system calls.
`static java.lang.String`	`MTU_LENGTH_PROP_NAME` Length of the maximum transmission unit of the media driver's protocol
`static java.lang.String`	`MULTICAST_FLOW_CONTROL_STRATEGY` `FlowControl` to be employed for multicast channels.
`static java.lang.String`	`MULTICAST_FLOW_CONTROL_STRATEGY_PROP_NAME` Property name for `FlowControl` to be employed for multicast channels.
`static java.lang.String`	`MULTICAST_FLOW_CONTROL_STRATEGY_SUPPLIER` `FlowControlSupplier` to be employed for multicast channels.
`static java.lang.String`	`MULTICAST_FLOW_CONTROL_STRATEGY_SUPPLIER_PROP_NAME` Property name for `FlowControlSupplier` to be employed for unicast channels.
`static int`	`NAK_GROUPSIZE_DEFAULT` Default group size estimate for NAK delay randomization.
`static int`	`NAK_GRTT_DEFAULT` Default group RTT estimate for NAK delay randomization in ms.
`static long`	`NAK_MAX_BACKOFF_DEFAULT` Default max backoff for NAK delay randomization in ms.
`static OptimalMulticastDelayGenerator`	`NAK_MULTICAST_DELAY_GENERATOR` Multicast NAK delay is immediate initial with delayed subsequent delay.
`static long`	`NAK_UNICAST_DELAY_DEFAULT_NS` Default Unicast NAK delay in nanoseconds.
`static StaticDelayGenerator`	`NAK_UNICAST_DELAY_GENERATOR` Unicast NAK delay is immediate initial with delayed subsequent delay.
`static long`	`PENDING_SETUPS_TIMEOUT_NS` Timeout on cleaning up pending SETUP state on subscriber.
`static long`	`PUBLICATION_HEARTBEAT_TIMEOUT_NS` Timeout between heartbeats for publications.
`static long`	`PUBLICATION_LINGER_DEFAULT_NS` Default time for `Publication`s to linger before cleanup.
`static long`	`PUBLICATION_LINGER_NS` Time for `Publication`s to linger before cleanup.
`static java.lang.String`	`PUBLICATION_LINGER_PROP_NAME` Property name for linger timeout on `Publication`s.
`static long`	`PUBLICATION_SETUP_TIMEOUT_NS` Timeout between SETUP frames for publications during initial setup phase.
`static int`	`PUBLICATION_TERM_WINDOW_LENGTH` Publication term window length for flow control in bytes.
`static java.lang.String`	`PUBLICATION_TERM_WINDOW_LENGTH_PROP_NAME` Property name for window limit on `Publication` side.
`static long`	`PUBLICATION_UNBLOCK_TIMEOUT_DEFAULT_NS` Timeout for `Publication` unblock in nanoseconds.
`static long`	`PUBLICATION_UNBLOCK_TIMEOUT_NS` Publication timeout for when to unblock a partially written message.
`static java.lang.String`	`PUBLICATION_UNBLOCK_TIMEOUT_PROP_NAME` Property name for `Publication` unblock timeout.
`static java.lang.String`	`RECEIVE_CHANNEL_ENDPOINT_SUPPLIER` `ReceiveChannelEndpointSupplier` to provide endpoint extension behaviour.
`static java.lang.String`	`RECEIVE_CHANNEL_ENDPOINT_SUPPLIER_PROP_NAME` Property name for `ReceiveChannelEndpointSupplier`.
`static java.lang.String`	`RECEIVER_IDLE_STRATEGY` `IdleStrategy` to be employed by `Receiver` for `ThreadingMode.DEDICATED`.
`static java.lang.String`	`RECEIVER_IDLE_STRATEGY_PROP_NAME` Property name for `IdleStrategy` to be employed by `Receiver` for `ThreadingMode.DEDICATED`.
`static long`	`RETRANSMIT_UNICAST_DELAY_DEFAULT_NS` Default delay for retransmission of data for unicast.
`static FeedbackDelayGenerator`	`RETRANSMIT_UNICAST_DELAY_GENERATOR` Source uses same for unicast and multicast.
`static long`	`RETRANSMIT_UNICAST_LINGER_DEFAULT_NS` Default delay for linger for unicast.
`static FeedbackDelayGenerator`	`RETRANSMIT_UNICAST_LINGER_GENERATOR` Delay for linger for unicast.
`static java.lang.String`	`SEND_CHANNEL_ENDPOINT_SUPPLIER` `SendChannelEndpointSupplier` to provide endpoint extension behaviour.
`static java.lang.String`	`SEND_CHANNEL_ENDPOINT_SUPPLIER_PROP_NAME` Property name for `SendChannelEndpointSupplier`.
`static int`	`SEND_TO_STATUS_POLL_RATIO_DEFAULT` The ratio for sending data to polling status messages in the Sender.
`static java.lang.String`	`SEND_TO_STATUS_POLL_RATIO_PROP_NAME` Property name for ratio of sending data to polling status messages in the Sender.
`static java.lang.String`	`SENDER_IDLE_STRATEGY` `IdleStrategy` to be employed by `Sender` for `ThreadingMode.DEDICATED`.
`static java.lang.String`	`SENDER_IDLE_STRATEGY_PROP_NAME` Property name for `IdleStrategy` to be employed by `Sender` for `ThreadingMode.DEDICATED`.
`static java.lang.String`	`SHARED_IDLE_STRATEGY` `IdleStrategy` to be employed by `Sender`, `Receiver`, and `DriverConductor` for `ThreadingMode.SHARED`.
`static java.lang.String`	`SHARED_IDLE_STRATEGY_PROP_NAME` Property name for `IdleStrategy` to be employed by `Sender`, `Receiver`, and `DriverConductor` for `ThreadingMode.SHARED`.
`static java.lang.String`	`SHARED_NETWORK_IDLE_STRATEGY` `IdleStrategy` to be employed by `Sender` and `Receiver` for `ThreadingMode.SHARED_NETWORK`.
`static java.lang.String`	`SHARED_NETWORK_IDLE_STRATEGY_PROP_NAME` Property name for `IdleStrategy` to be employed by `Sender` and `Receiver` for `ThreadingMode.SHARED_NETWORK`.
`static byte[]`	`SM_APPLICATION_SPECIFIC_FEEDBACK` Value to use for all Status Message Application Specific Feedback values from the driver.
`static java.lang.String`	`SM_APPLICATION_SPECIFIC_FEEDBACK_PROP_NAME` Property name for Application Specific Feedback added to Status Messages by the driver.
`static int`	`SOCKET_MULTICAST_TTL` Multicast TTL value.
`static int`	`SOCKET_MULTICAST_TTL_DEFAULT` Multicast TTL value, 0 means use OS default.
`static java.lang.String`	`SOCKET_MULTICAST_TTL_PROP_NAME` Property name for IP_MULTICAST_TTL setting on UDP sockets.
`static int`	`SOCKET_RCVBUF_LENGTH` SO_RCVBUF length, 0 means use OS default.
`static int`	`SOCKET_RCVBUF_LENGTH_DEFAULT` Default SO_RCVBUF length.
`static java.lang.String`	`SOCKET_RCVBUF_LENGTH_PROP_NAME` Property name for SO_RCVBUF setting on UDP sockets which must be sufficient for Bandwidth Delay Produce (BDP).
`static int`	`SOCKET_SNDBUF_LENGTH` SO_SNDBUF length, 0 means use OS default.
`static int`	`SOCKET_SNDBUF_LENGTH_DEFAULT` Default SO_SNDBUF length.
`static java.lang.String`	`SOCKET_SNDBUF_LENGTH_PROP_NAME` Property name for SO_SNDBUF setting on UDP sockets which must be sufficient for Bandwidth Delay Produce (BDP).
`static long`	`STATUS_MESSAGE_TIMEOUT_DEFAULT_NS` Max timeout between SMs.
`static java.lang.String`	`STATUS_MESSAGE_TIMEOUT_PROP_NAME` Property name for status message timeout in nanoseconds.
`static int`	`TERM_BUFFER_IPC_LENGTH_DEFAULT` Default IPC term buffer length.
`static int`	`TERM_BUFFER_LENGTH_DEFAULT` Default term buffer length.
`static int`	`TERM_BUFFER_LENGTH_MAX_DEFAULT` Default term max buffer length.
`static java.lang.String`	`TERM_BUFFER_LENGTH_PROP_NAME` Length (in bytes) of the log buffers for publication terms.
`static java.lang.String`	`TERM_BUFFER_MAX_LENGTH_PROP_NAME` Length (in bytes) of the log buffers for terms.
`static java.lang.String`	`TERM_BUFFER_SPARSE_FILE` Should term buffers be created as sparse files.
`static java.lang.String`	`TERM_BUFFER_SPARSE_FILE_PROP_NAME` Property name for boolean value of term buffers should be created sparse.
`static java.lang.String`	`THREADING_MODE_PROP_NAME` `ThreadingMode` to be used by the Aeron `MediaDriver`
`static int`	`TO_CLIENTS_BUFFER_LENGTH` Length for broadcast buffers from the media driver and the clients.
`static int`	`TO_CLIENTS_BUFFER_LENGTH_DEFAULT` Default buffer length for broadcast buffers from the media driver and the clients.
`static java.lang.String`	`TO_CLIENTS_BUFFER_LENGTH_PROP_NAME` Length (in bytes) of the broadcast buffers from the media driver to the clients.
`static java.lang.String`	`UNICAST_FLOW_CONTROL_STRATEGY` `FlowControl` to be employed for unicast channels.
`static java.lang.String`	`UNICAST_FLOW_CONTROL_STRATEGY_PROP_NAME` Property name for `FlowControl` to be employed for unicast channels.
`static java.lang.String`	`UNICAST_FLOW_CONTROL_STRATEGY_SUPPLIER` `FlowControlSupplier` to be employed for unicast channels.
`static java.lang.String`	`UNICAST_FLOW_CONTROL_STRATEGY_SUPPLIER_PROP_NAME` Property name for `FlowControlSupplier` to be employed for unicast channels.

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 org.agrona.concurrent.IdleStrategy`	`agentIdleStrategy(java.lang.String strategyName, org.agrona.concurrent.status.StatusIndicator controllableStatus)` Get the `IdleStrategy` that should be applied to `Agent`s.
`static int`	`ipcPublicationTermWindowLength(int termBufferLength)` How far ahead the publisher can get from the sender position for IPC only.
`static int`	`ipcTermBufferLength(int termBufferLength)` How large the term buffer should be for IPC only.
`static int`	`publicationTermWindowLength(int termBufferLength)` How far ahead the publisher can get from the sender position.
`static void`	`validateInitialWindowLength(int initialWindowLength, int mtuLength)` Validate that the initial window length is suitably greater than MTU.
`static void`	`validateMtuLength(int mtuLength)` Validate the the MTU is an appropriate length.
`static void`	`validateTermBufferLength(int length)` Validate the the term buffer length is a power of two.

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

- Field Detail
  - TERM_BUFFER_SPARSE_FILE_PROP_NAME
```
public static final java.lang.String TERM_BUFFER_SPARSE_FILE_PROP_NAME
```
    Property name for boolean value of term buffers should be created sparse.
    
    See Also:
    
    Constant Field Values
  - TERM_BUFFER_SPARSE_FILE
```
public static final java.lang.String TERM_BUFFER_SPARSE_FILE
```
    Should term buffers be created as sparse files. Defaults to false. If a platform supports sparse files then log buffer creation is faster with pages being allocated as needed. This can help for large numbers of channels/streams but can result in latency pauses.
  - TERM_BUFFER_MAX_LENGTH_PROP_NAME
```
public static final java.lang.String TERM_BUFFER_MAX_LENGTH_PROP_NAME
```
    Length (in bytes) of the log buffers for terms.
    
    See Also:
    
    Constant Field Values
  - TERM_BUFFER_LENGTH_MAX_DEFAULT
```
public static final int TERM_BUFFER_LENGTH_MAX_DEFAULT
```
    Default term max buffer length. The maximum possible term length is 1GB.
    
    See Also:
    
    Constant Field Values
  - TERM_BUFFER_LENGTH_PROP_NAME
```
public static final java.lang.String TERM_BUFFER_LENGTH_PROP_NAME
```
    Length (in bytes) of the log buffers for publication terms.
    
    See Also:
    
    Constant Field Values
  - TERM_BUFFER_LENGTH_DEFAULT
```
public static final int TERM_BUFFER_LENGTH_DEFAULT
```
    Default term buffer length.
    
    See Also:
    
    Constant Field Values
  - IPC_TERM_BUFFER_LENGTH_PROP_NAME
```
public static final java.lang.String IPC_TERM_BUFFER_LENGTH_PROP_NAME
```
    Property name for term buffer length (in bytes) for IPC buffers.
    
    See Also:
    
    Constant Field Values
  - TERM_BUFFER_IPC_LENGTH_DEFAULT
```
public static final int TERM_BUFFER_IPC_LENGTH_DEFAULT
```
    Default IPC term buffer length.
    
    See Also:
    
    Constant Field Values
  - IPC_TERM_BUFFER_LENGTH
```
public static final int IPC_TERM_BUFFER_LENGTH
```
    IPC Term buffer length in bytes.
  - LOW_FILE_STORE_WARNING_THRESHOLD_PROP_NAME
```
public static final java.lang.String LOW_FILE_STORE_WARNING_THRESHOLD_PROP_NAME
```
    Property name low file storage warning threshold.
    
    See Also:
    
    Constant Field Values
  - LOW_FILE_STORE_WARNING_THRESHOLD_DEFAULT
```
public static final long LOW_FILE_STORE_WARNING_THRESHOLD_DEFAULT
```
    Default value for low file storage warning threshold.
    
    See Also:
    
    Constant Field Values
  - LOW_FILE_STORE_WARNING_THRESHOLD
```
public static final long LOW_FILE_STORE_WARNING_THRESHOLD
```
    Default value for low file storage warning threshold.
  - CONDUCTOR_BUFFER_LENGTH_PROP_NAME
```
public static final java.lang.String CONDUCTOR_BUFFER_LENGTH_PROP_NAME
```
    Length (in bytes) of the conductor buffer for control commands from the clients to the media driver conductor.
    
    See Also:
    
    Constant Field Values
  - CONDUCTOR_BUFFER_LENGTH_DEFAULT
```
public static final int CONDUCTOR_BUFFER_LENGTH_DEFAULT
```
    Default buffer length for conductor buffers between the client and the media driver conductor.
  - CONDUCTOR_BUFFER_LENGTH
```
public static final int CONDUCTOR_BUFFER_LENGTH
```
    Conductor buffer length in bytes.
  - TO_CLIENTS_BUFFER_LENGTH_PROP_NAME
```
public static final java.lang.String TO_CLIENTS_BUFFER_LENGTH_PROP_NAME
```
    Length (in bytes) of the broadcast buffers from the media driver to the clients.
    
    See Also:
    
    Constant Field Values
  - TO_CLIENTS_BUFFER_LENGTH_DEFAULT
```
public static final int TO_CLIENTS_BUFFER_LENGTH_DEFAULT
```
    Default buffer length for broadcast buffers from the media driver and the clients.
  - TO_CLIENTS_BUFFER_LENGTH
```
public static final int TO_CLIENTS_BUFFER_LENGTH
```
    Length for broadcast buffers from the media driver and the clients.
  - COUNTERS_VALUES_BUFFER_LENGTH_PROP_NAME
```
public static final java.lang.String COUNTERS_VALUES_BUFFER_LENGTH_PROP_NAME
```
    Property name for length of the error buffer for the system counters.
    
    See Also:
    
    Constant Field Values
  - COUNTERS_VALUES_BUFFER_LENGTH_DEFAULT
```
public static final int COUNTERS_VALUES_BUFFER_LENGTH_DEFAULT
```
    Default length of the memory mapped buffers for the system counters file.
    
    See Also:
    
    Constant Field Values
  - COUNTERS_VALUES_BUFFER_LENGTH
```
public static final int COUNTERS_VALUES_BUFFER_LENGTH
```
    Length of the memory mapped buffers for the system counters file.
  - COUNTERS_METADATA_BUFFER_LENGTH
```
public static final int COUNTERS_METADATA_BUFFER_LENGTH
```
  - ERROR_BUFFER_LENGTH_PROP_NAME
```
public static final java.lang.String ERROR_BUFFER_LENGTH_PROP_NAME
```
    Property name for length of the memory mapped buffer for the distinct error log.
    
    See Also:
    
    Constant Field Values
  - ERROR_BUFFER_LENGTH_DEFAULT
```
public static final int ERROR_BUFFER_LENGTH_DEFAULT
```
    Default buffer length for the error buffer for the media driver.
    
    See Also:
    
    Constant Field Values
  - ERROR_BUFFER_LENGTH
```
public static final int ERROR_BUFFER_LENGTH
```
    Buffer length for the error buffer for the media driver.
  - LOSS_REPORT_BUFFER_LENGTH_PROP_NAME
```
public static final java.lang.String LOSS_REPORT_BUFFER_LENGTH_PROP_NAME
```
    Property name for length of the memory mapped buffer for the loss report buffer.
    
    See Also:
    
    Constant Field Values
  - LOSS_REPORT_BUFFER_LENGTH_DEFAULT
```
public static final int LOSS_REPORT_BUFFER_LENGTH_DEFAULT
```
    Default buffer length for the loss report buffer.
    
    See Also:
    
    Constant Field Values
  - LOSS_REPORT_BUFFER_LENGTH
```
public static final int LOSS_REPORT_BUFFER_LENGTH
```
    Buffer length for the loss report buffer for the media driver.
  - INITIAL_WINDOW_LENGTH_PROP_NAME
```
public static final java.lang.String INITIAL_WINDOW_LENGTH_PROP_NAME
```
    Property name for length of the initial window which must be sufficient for Bandwidth Delay Produce (BDP).
    
    See Also:
    
    Constant Field Values
  - INITIAL_WINDOW_LENGTH_DEFAULT
```
public static final int INITIAL_WINDOW_LENGTH_DEFAULT
```
    Default initial window length for flow control sender to receiver purposes Length of Initial Window RTT (LAN) = 100 usec Throughput = 10 Gbps Buffer = Throughput * RTT Buffer = (10 * 1000 * 1000 * 1000 / 8) * 0.0001 = 125000 Round to 128KB
    
    See Also:
    
    Constant Field Values
  - STATUS_MESSAGE_TIMEOUT_PROP_NAME
```
public static final java.lang.String STATUS_MESSAGE_TIMEOUT_PROP_NAME
```
    Property name for status message timeout in nanoseconds.
    
    See Also:
    
    Constant Field Values
  - STATUS_MESSAGE_TIMEOUT_DEFAULT_NS
```
public static final long STATUS_MESSAGE_TIMEOUT_DEFAULT_NS
```
    Max timeout between SMs.
  - SEND_TO_STATUS_POLL_RATIO_PROP_NAME
```
public static final java.lang.String SEND_TO_STATUS_POLL_RATIO_PROP_NAME
```
    Property name for ratio of sending data to polling status messages in the Sender.
    
    See Also:
    
    Constant Field Values
  - SEND_TO_STATUS_POLL_RATIO_DEFAULT
```
public static final int SEND_TO_STATUS_POLL_RATIO_DEFAULT
```
    The ratio for sending data to polling status messages in the Sender.
    
    See Also:
    
    Constant Field Values
  - SOCKET_RCVBUF_LENGTH_PROP_NAME
```
public static final java.lang.String SOCKET_RCVBUF_LENGTH_PROP_NAME
```
    Property name for SO_RCVBUF setting on UDP sockets which must be sufficient for Bandwidth Delay Produce (BDP).
    
    See Also:
    
    Constant Field Values
  - SOCKET_RCVBUF_LENGTH_DEFAULT
```
public static final int SOCKET_RCVBUF_LENGTH_DEFAULT
```
    Default SO_RCVBUF length.
    
    See Also:
    
    Constant Field Values
  - SOCKET_RCVBUF_LENGTH
```
public static final int SOCKET_RCVBUF_LENGTH
```
    SO_RCVBUF length, 0 means use OS default.
  - SOCKET_SNDBUF_LENGTH_PROP_NAME
```
public static final java.lang.String SOCKET_SNDBUF_LENGTH_PROP_NAME
```
    Property name for SO_SNDBUF setting on UDP sockets which must be sufficient for Bandwidth Delay Produce (BDP).
    
    See Also:
    
    Constant Field Values
  - SOCKET_SNDBUF_LENGTH_DEFAULT
```
public static final int SOCKET_SNDBUF_LENGTH_DEFAULT
```
    Default SO_SNDBUF length.
    
    See Also:
    
    Constant Field Values
  - SOCKET_SNDBUF_LENGTH
```
public static final int SOCKET_SNDBUF_LENGTH
```
    SO_SNDBUF length, 0 means use OS default.
  - SOCKET_MULTICAST_TTL_PROP_NAME
```
public static final java.lang.String SOCKET_MULTICAST_TTL_PROP_NAME
```
    Property name for IP_MULTICAST_TTL setting on UDP sockets.
    
    See Also:
    
    Constant Field Values
  - SOCKET_MULTICAST_TTL_DEFAULT
```
public static final int SOCKET_MULTICAST_TTL_DEFAULT
```
    Multicast TTL value, 0 means use OS default.
    
    See Also:
    
    Constant Field Values
  - SOCKET_MULTICAST_TTL
```
public static final int SOCKET_MULTICAST_TTL
```
    Multicast TTL value.
  - PUBLICATION_LINGER_PROP_NAME
```
public static final java.lang.String PUBLICATION_LINGER_PROP_NAME
```
    Property name for linger timeout on Publications.
    
    See Also:
    
    Constant Field Values
  - PUBLICATION_LINGER_DEFAULT_NS
```
public static final long PUBLICATION_LINGER_DEFAULT_NS
```
    Default time for Publications to linger before cleanup.
  - PUBLICATION_LINGER_NS
```
public static final long PUBLICATION_LINGER_NS
```
    Time for Publications to linger before cleanup.
  - CLIENT_LIVENESS_TIMEOUT_PROP_NAME
```
public static final java.lang.String CLIENT_LIVENESS_TIMEOUT_PROP_NAME
```
    Property name for Aeron client liveness timeout.
    
    See Also:
    
    Constant Field Values
  - CLIENT_LIVENESS_TIMEOUT_DEFAULT_NS
```
public static final long CLIENT_LIVENESS_TIMEOUT_DEFAULT_NS
```
    Default timeout for client liveness in nanoseconds.
  - CLIENT_LIVENESS_TIMEOUT_NS
```
public static final long CLIENT_LIVENESS_TIMEOUT_NS
```
    Timeout for client liveness in nanoseconds.
  - IMAGE_LIVENESS_TIMEOUT_PROP_NAME
```
public static final java.lang.String IMAGE_LIVENESS_TIMEOUT_PROP_NAME
```
    Property name for Image liveness timeout.
    
    See Also:
    
    Constant Field Values
  - IMAGE_LIVENESS_TIMEOUT_DEFAULT_NS
```
public static final long IMAGE_LIVENESS_TIMEOUT_DEFAULT_NS
```
    Default timeout for Image liveness in nanoseconds.
  - IMAGE_LIVENESS_TIMEOUT_NS
```
public static final long IMAGE_LIVENESS_TIMEOUT_NS
```
    Timeout for Image liveness in nanoseconds.
  - PUBLICATION_TERM_WINDOW_LENGTH_PROP_NAME
```
public static final java.lang.String PUBLICATION_TERM_WINDOW_LENGTH_PROP_NAME
```
    Property name for window limit on Publication side.
    
    See Also:
    
    Constant Field Values
  - PUBLICATION_TERM_WINDOW_LENGTH
```
public static final int PUBLICATION_TERM_WINDOW_LENGTH
```
    Publication term window length for flow control in bytes.
  - IPC_PUBLICATION_TERM_WINDOW_LENGTH_PROP_NAME
```
public static final java.lang.String IPC_PUBLICATION_TERM_WINDOW_LENGTH_PROP_NAME
```
    Property name for window limit for IPC publications.
    
    See Also:
    
    Constant Field Values
  - IPC_PUBLICATION_TERM_WINDOW_LENGTH
```
public static final int IPC_PUBLICATION_TERM_WINDOW_LENGTH
```
    IPC Publication term window length for flow control in bytes.
  - PUBLICATION_UNBLOCK_TIMEOUT_PROP_NAME
```
public static final java.lang.String PUBLICATION_UNBLOCK_TIMEOUT_PROP_NAME
```
    Property name for Publication unblock timeout.
    
    See Also:
    
    Constant Field Values
  - PUBLICATION_UNBLOCK_TIMEOUT_DEFAULT_NS
```
public static final long PUBLICATION_UNBLOCK_TIMEOUT_DEFAULT_NS
```
    Timeout for Publication unblock in nanoseconds.
  - PUBLICATION_UNBLOCK_TIMEOUT_NS
```
public static final long PUBLICATION_UNBLOCK_TIMEOUT_NS
```
    Publication timeout for when to unblock a partially written message.
  - SENDER_IDLE_STRATEGY_PROP_NAME
```
public static final java.lang.String SENDER_IDLE_STRATEGY_PROP_NAME
```
    Property name for IdleStrategy to be employed by Sender for ThreadingMode.DEDICATED.
    
    See Also:
    
    Constant Field Values
  - SENDER_IDLE_STRATEGY
```
public static final java.lang.String SENDER_IDLE_STRATEGY
```
    IdleStrategy to be employed by Sender for ThreadingMode.DEDICATED.
  - CONDUCTOR_IDLE_STRATEGY_PROP_NAME
```
public static final java.lang.String CONDUCTOR_IDLE_STRATEGY_PROP_NAME
```
    Property name for IdleStrategy to be employed by DriverConductor for ThreadingMode.DEDICATED and ThreadingMode.SHARED_NETWORK.
    
    See Also:
    
    Constant Field Values
  - CONDUCTOR_IDLE_STRATEGY
```
public static final java.lang.String CONDUCTOR_IDLE_STRATEGY
```
    IdleStrategy to be employed by DriverConductor for ThreadingMode.DEDICATED and ThreadingMode.SHARED_NETWORK.
  - RECEIVER_IDLE_STRATEGY_PROP_NAME
```
public static final java.lang.String RECEIVER_IDLE_STRATEGY_PROP_NAME
```
    Property name for IdleStrategy to be employed by Receiver for ThreadingMode.DEDICATED.
    
    See Also:
    
    Constant Field Values
  - RECEIVER_IDLE_STRATEGY
```
public static final java.lang.String RECEIVER_IDLE_STRATEGY
```
    IdleStrategy to be employed by Receiver for ThreadingMode.DEDICATED.
  - SHARED_NETWORK_IDLE_STRATEGY_PROP_NAME
```
public static final java.lang.String SHARED_NETWORK_IDLE_STRATEGY_PROP_NAME
```
    Property name for IdleStrategy to be employed by Sender and Receiver for ThreadingMode.SHARED_NETWORK.
    
    See Also:
    
    Constant Field Values
  - SHARED_NETWORK_IDLE_STRATEGY
```
public static final java.lang.String SHARED_NETWORK_IDLE_STRATEGY
```
    IdleStrategy to be employed by Sender and Receiver for ThreadingMode.SHARED_NETWORK.
  - SHARED_IDLE_STRATEGY_PROP_NAME
```
public static final java.lang.String SHARED_IDLE_STRATEGY_PROP_NAME
```
    Property name for IdleStrategy to be employed by Sender, Receiver, and DriverConductor for ThreadingMode.SHARED.
    
    See Also:
    
    Constant Field Values
  - SHARED_IDLE_STRATEGY
```
public static final java.lang.String SHARED_IDLE_STRATEGY
```
    IdleStrategy to be employed by Sender, Receiver, and DriverConductor for ThreadingMode.SHARED.
  - UNICAST_FLOW_CONTROL_STRATEGY_PROP_NAME
```
public static final java.lang.String UNICAST_FLOW_CONTROL_STRATEGY_PROP_NAME
```
    Property name for FlowControl to be employed for unicast channels.
    
    See Also:
    
    Constant Field Values
  - UNICAST_FLOW_CONTROL_STRATEGY
```
public static final java.lang.String UNICAST_FLOW_CONTROL_STRATEGY
```
    FlowControl to be employed for unicast channels.
  - MULTICAST_FLOW_CONTROL_STRATEGY_PROP_NAME
```
public static final java.lang.String MULTICAST_FLOW_CONTROL_STRATEGY_PROP_NAME
```
    Property name for FlowControl to be employed for multicast channels.
    
    See Also:
    
    Constant Field Values
  - MULTICAST_FLOW_CONTROL_STRATEGY
```
public static final java.lang.String MULTICAST_FLOW_CONTROL_STRATEGY
```
    FlowControl to be employed for multicast channels.
  - UNICAST_FLOW_CONTROL_STRATEGY_SUPPLIER_PROP_NAME
```
public static final java.lang.String UNICAST_FLOW_CONTROL_STRATEGY_SUPPLIER_PROP_NAME
```
    Property name for FlowControlSupplier to be employed for unicast channels.
    
    See Also:
    
    Constant Field Values
  - UNICAST_FLOW_CONTROL_STRATEGY_SUPPLIER
```
public static final java.lang.String UNICAST_FLOW_CONTROL_STRATEGY_SUPPLIER
```
    FlowControlSupplier to be employed for unicast channels.
  - MULTICAST_FLOW_CONTROL_STRATEGY_SUPPLIER_PROP_NAME
```
public static final java.lang.String MULTICAST_FLOW_CONTROL_STRATEGY_SUPPLIER_PROP_NAME
```
    Property name for FlowControlSupplier to be employed for unicast channels.
    
    See Also:
    
    Constant Field Values
  - MULTICAST_FLOW_CONTROL_STRATEGY_SUPPLIER
```
public static final java.lang.String MULTICAST_FLOW_CONTROL_STRATEGY_SUPPLIER
```
    FlowControlSupplier to be employed for multicast channels.
  - MTU_LENGTH_PROP_NAME
```
public static final java.lang.String MTU_LENGTH_PROP_NAME
```
    Length of the maximum transmission unit of the media driver's protocol
    
    See Also:
    
    Constant Field Values
  - MTU_LENGTH_DEFAULT
```
public static final int MTU_LENGTH_DEFAULT
```
    Default length is greater than typical Ethernet MTU so will fragment to save on system calls.
    
    See Also:
    
    Constant Field Values
  - MTU_LENGTH
```
public static final int MTU_LENGTH
```
    Length of the MTU to use for sending messages.
  - MAX_UDP_PAYLOAD_LENGTH
```
public static final int MAX_UDP_PAYLOAD_LENGTH
```
    Maximum UDP datagram payload size for IPv4. Jumbo datagrams from IPv6 are not supported.
    
    See Also:
    
    Constant Field Values
  - THREADING_MODE_PROP_NAME
```
public static final java.lang.String THREADING_MODE_PROP_NAME
```
    ThreadingMode to be used by the Aeron MediaDriver
    
    See Also:
    
    Constant Field Values
  - HEARTBEAT_TIMEOUT_NS
```
public static final long HEARTBEAT_TIMEOUT_NS
```
    How often to check liveness and cleanup
  - SEND_CHANNEL_ENDPOINT_SUPPLIER_PROP_NAME
```
public static final java.lang.String SEND_CHANNEL_ENDPOINT_SUPPLIER_PROP_NAME
```
    Property name for SendChannelEndpointSupplier.
    
    See Also:
    
    Constant Field Values
  - SEND_CHANNEL_ENDPOINT_SUPPLIER
```
public static final java.lang.String SEND_CHANNEL_ENDPOINT_SUPPLIER
```
    SendChannelEndpointSupplier to provide endpoint extension behaviour.
  - RECEIVE_CHANNEL_ENDPOINT_SUPPLIER_PROP_NAME
```
public static final java.lang.String RECEIVE_CHANNEL_ENDPOINT_SUPPLIER_PROP_NAME
```
    Property name for ReceiveChannelEndpointSupplier.
    
    See Also:
    
    Constant Field Values
  - RECEIVE_CHANNEL_ENDPOINT_SUPPLIER
```
public static final java.lang.String RECEIVE_CHANNEL_ENDPOINT_SUPPLIER
```
    ReceiveChannelEndpointSupplier to provide endpoint extension behaviour.
  - SM_APPLICATION_SPECIFIC_FEEDBACK_PROP_NAME
```
public static final java.lang.String SM_APPLICATION_SPECIFIC_FEEDBACK_PROP_NAME
```
    Property name for Application Specific Feedback added to Status Messages by the driver.
    
    See Also:
    
    Constant Field Values
  - SM_APPLICATION_SPECIFIC_FEEDBACK
```
public static final byte[] SM_APPLICATION_SPECIFIC_FEEDBACK
```
    Value to use for all Status Message Application Specific Feedback values from the driver.
  - CONGESTION_CONTROL_STRATEGY_SUPPLIER_PROP_NAME
```
public static final java.lang.String CONGESTION_CONTROL_STRATEGY_SUPPLIER_PROP_NAME
```
    Property name for CongestionControlSupplier to be employed for receivers.
    
    See Also:
    
    Constant Field Values
  - CONGESTION_CONTROL_STRATEGY_SUPPLIER
```
public static final java.lang.String CONGESTION_CONTROL_STRATEGY_SUPPLIER
```
    CongestionControlSupplier to be employed for receivers.
  - CMD_QUEUE_CAPACITY
```
public static final int CMD_QUEUE_CAPACITY
```
    Capacity for the command queues used between driver agents.
    
    See Also:
    
    Constant Field Values
  - PENDING_SETUPS_TIMEOUT_NS
```
public static final long PENDING_SETUPS_TIMEOUT_NS
```
    Timeout on cleaning up pending SETUP state on subscriber.
  - PUBLICATION_SETUP_TIMEOUT_NS
```
public static final long PUBLICATION_SETUP_TIMEOUT_NS
```
    Timeout between SETUP frames for publications during initial setup phase.
  - PUBLICATION_HEARTBEAT_TIMEOUT_NS
```
public static final long PUBLICATION_HEARTBEAT_TIMEOUT_NS
```
    Timeout between heartbeats for publications.
  - NAK_GROUPSIZE_DEFAULT
```
public static final int NAK_GROUPSIZE_DEFAULT
```
    Default group size estimate for NAK delay randomization.
    
    See Also:
    
    Constant Field Values
  - NAK_GRTT_DEFAULT
```
public static final int NAK_GRTT_DEFAULT
```
    Default group RTT estimate for NAK delay randomization in ms.
    
    See Also:
    
    Constant Field Values
  - NAK_MAX_BACKOFF_DEFAULT
```
public static final long NAK_MAX_BACKOFF_DEFAULT
```
    Default max backoff for NAK delay randomization in ms.
  - NAK_MULTICAST_DELAY_GENERATOR
```
public static final OptimalMulticastDelayGenerator NAK_MULTICAST_DELAY_GENERATOR
```
    Multicast NAK delay is immediate initial with delayed subsequent delay.
  - NAK_UNICAST_DELAY_DEFAULT_NS
```
public static final long NAK_UNICAST_DELAY_DEFAULT_NS
```
    Default Unicast NAK delay in nanoseconds.
  - NAK_UNICAST_DELAY_GENERATOR
```
public static final StaticDelayGenerator NAK_UNICAST_DELAY_GENERATOR
```
    Unicast NAK delay is immediate initial with delayed subsequent delay.
  - RETRANSMIT_UNICAST_DELAY_DEFAULT_NS
```
public static final long RETRANSMIT_UNICAST_DELAY_DEFAULT_NS
```
    Default delay for retransmission of data for unicast.
  - RETRANSMIT_UNICAST_DELAY_GENERATOR
```
public static final FeedbackDelayGenerator RETRANSMIT_UNICAST_DELAY_GENERATOR
```
    Source uses same for unicast and multicast. For ticks.
  - RETRANSMIT_UNICAST_LINGER_DEFAULT_NS
```
public static final long RETRANSMIT_UNICAST_LINGER_DEFAULT_NS
```
    Default delay for linger for unicast.
  - RETRANSMIT_UNICAST_LINGER_GENERATOR
```
public static final FeedbackDelayGenerator RETRANSMIT_UNICAST_LINGER_GENERATOR
```
    Delay for linger for unicast.
  - MAX_RETRANSMITS_DEFAULT
```
public static final int MAX_RETRANSMITS_DEFAULT
```
    Default max number of active retransmissions per connected stream.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Configuration
```
public Configuration()
```
- Method Detail
  - validateTermBufferLength
```
public static void validateTermBufferLength(int length)
```
    Validate the the term buffer length is a power of two.
    
    Parameters:
    
    length - of the term buffer
  - publicationTermWindowLength
```
public static int publicationTermWindowLength(int termBufferLength)
```
    How far ahead the publisher can get from the sender position.
    
    Parameters:
    
    termBufferLength - to be used when PUBLICATION_TERM_WINDOW_LENGTH is not set.
    
    Returns:
    
    the length to be used for the publication window.
  - ipcPublicationTermWindowLength
```
public static int ipcPublicationTermWindowLength(int termBufferLength)
```
    How far ahead the publisher can get from the sender position for IPC only.
    
    Parameters:
    
    termBufferLength - to be used when IPC_PUBLICATION_TERM_WINDOW_LENGTH is not set.
    
    Returns:
    
    the length to be used for the publication window.
  - ipcTermBufferLength
```
public static int ipcTermBufferLength(int termBufferLength)
```
    How large the term buffer should be for IPC only.
    
    Parameters:
    
    termBufferLength - to be used when IPC_TERM_BUFFER_LENGTH is not set.
    
    Returns:
    
    the length to be used for the term buffer in bytes
  - validateInitialWindowLength
```
public static void validateInitialWindowLength(int initialWindowLength,
                                               int mtuLength)
```
    Validate that the initial window length is suitably greater than MTU.
    
    Parameters:
    
    initialWindowLength - to be validated.
    
    mtuLength - against which to validate.
  - agentIdleStrategy
```
public static org.agrona.concurrent.IdleStrategy agentIdleStrategy(java.lang.String strategyName,
                                                                   org.agrona.concurrent.status.StatusIndicator controllableStatus)
```
    Get the IdleStrategy that should be applied to Agents.
    
    Parameters:
    
    strategyName - to be created.
    
    controllableStatus - status indicator for what the strategy should do.
    
    Returns:
    
    the newly created IdleStrategy.
  - validateMtuLength
```
public static void validateMtuLength(int mtuLength)
```
    Validate the the MTU is an appropriate length. MTU lengths must be a multiple of FrameDescriptor.FRAME_ALIGNMENT.
    
    Parameters:
    
    mtuLength - to be validated.
    
    Throws:
    
    ConfigurationException - if the MTU length is not valid.

Class Configuration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TERM_BUFFER_SPARSE_FILE_PROP_NAME

TERM_BUFFER_SPARSE_FILE

TERM_BUFFER_MAX_LENGTH_PROP_NAME

TERM_BUFFER_LENGTH_MAX_DEFAULT

TERM_BUFFER_LENGTH_PROP_NAME

TERM_BUFFER_LENGTH_DEFAULT

IPC_TERM_BUFFER_LENGTH_PROP_NAME

TERM_BUFFER_IPC_LENGTH_DEFAULT

IPC_TERM_BUFFER_LENGTH

LOW_FILE_STORE_WARNING_THRESHOLD_PROP_NAME

LOW_FILE_STORE_WARNING_THRESHOLD_DEFAULT

LOW_FILE_STORE_WARNING_THRESHOLD

CONDUCTOR_BUFFER_LENGTH_PROP_NAME

CONDUCTOR_BUFFER_LENGTH_DEFAULT

CONDUCTOR_BUFFER_LENGTH

TO_CLIENTS_BUFFER_LENGTH_PROP_NAME

TO_CLIENTS_BUFFER_LENGTH_DEFAULT

TO_CLIENTS_BUFFER_LENGTH

COUNTERS_VALUES_BUFFER_LENGTH_PROP_NAME

COUNTERS_VALUES_BUFFER_LENGTH_DEFAULT

COUNTERS_VALUES_BUFFER_LENGTH

COUNTERS_METADATA_BUFFER_LENGTH

ERROR_BUFFER_LENGTH_PROP_NAME

ERROR_BUFFER_LENGTH_DEFAULT

ERROR_BUFFER_LENGTH

LOSS_REPORT_BUFFER_LENGTH_PROP_NAME

LOSS_REPORT_BUFFER_LENGTH_DEFAULT

LOSS_REPORT_BUFFER_LENGTH

INITIAL_WINDOW_LENGTH_PROP_NAME

INITIAL_WINDOW_LENGTH_DEFAULT

STATUS_MESSAGE_TIMEOUT_PROP_NAME

STATUS_MESSAGE_TIMEOUT_DEFAULT_NS

SEND_TO_STATUS_POLL_RATIO_PROP_NAME

SEND_TO_STATUS_POLL_RATIO_DEFAULT

SOCKET_RCVBUF_LENGTH_PROP_NAME

SOCKET_RCVBUF_LENGTH_DEFAULT

SOCKET_RCVBUF_LENGTH

SOCKET_SNDBUF_LENGTH_PROP_NAME

SOCKET_SNDBUF_LENGTH_DEFAULT

SOCKET_SNDBUF_LENGTH

SOCKET_MULTICAST_TTL_PROP_NAME

SOCKET_MULTICAST_TTL_DEFAULT

SOCKET_MULTICAST_TTL

PUBLICATION_LINGER_PROP_NAME

PUBLICATION_LINGER_DEFAULT_NS

PUBLICATION_LINGER_NS

CLIENT_LIVENESS_TIMEOUT_PROP_NAME

CLIENT_LIVENESS_TIMEOUT_DEFAULT_NS

CLIENT_LIVENESS_TIMEOUT_NS

IMAGE_LIVENESS_TIMEOUT_PROP_NAME

IMAGE_LIVENESS_TIMEOUT_DEFAULT_NS

IMAGE_LIVENESS_TIMEOUT_NS

PUBLICATION_TERM_WINDOW_LENGTH_PROP_NAME

PUBLICATION_TERM_WINDOW_LENGTH

IPC_PUBLICATION_TERM_WINDOW_LENGTH_PROP_NAME

IPC_PUBLICATION_TERM_WINDOW_LENGTH

PUBLICATION_UNBLOCK_TIMEOUT_PROP_NAME

PUBLICATION_UNBLOCK_TIMEOUT_DEFAULT_NS

PUBLICATION_UNBLOCK_TIMEOUT_NS

SENDER_IDLE_STRATEGY_PROP_NAME

SENDER_IDLE_STRATEGY

CONDUCTOR_IDLE_STRATEGY_PROP_NAME

CONDUCTOR_IDLE_STRATEGY

RECEIVER_IDLE_STRATEGY_PROP_NAME

RECEIVER_IDLE_STRATEGY

SHARED_NETWORK_IDLE_STRATEGY_PROP_NAME

SHARED_NETWORK_IDLE_STRATEGY

SHARED_IDLE_STRATEGY_PROP_NAME

SHARED_IDLE_STRATEGY

UNICAST_FLOW_CONTROL_STRATEGY_PROP_NAME

UNICAST_FLOW_CONTROL_STRATEGY

MULTICAST_FLOW_CONTROL_STRATEGY_PROP_NAME

MULTICAST_FLOW_CONTROL_STRATEGY

UNICAST_FLOW_CONTROL_STRATEGY_SUPPLIER_PROP_NAME