AeronCluster.Configuration (Aeron Message Transport)

java.lang.Object
- io.aeron.cluster.client.AeronCluster.Configuration

Enclosing class:: AeronCluster

public static final class AeronCluster.Configuration
extends Object

Configuration options for cluster client.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EGRESS_CHANNEL_DEFAULT` Channel for receiving response messages from a cluster.
`static String`	`EGRESS_CHANNEL_PROP_NAME` Channel for receiving response messages from a cluster.
`static int`	`EGRESS_STREAM_ID_DEFAULT` Default stream id within a channel for receiving messages from a cluster.
`static String`	`EGRESS_STREAM_ID_PROP_NAME` Stream id within a channel for receiving messages from a cluster.
`static String`	`INGRESS_CHANNEL_DEFAULT` Channel for sending messages to a cluster.
`static String`	`INGRESS_CHANNEL_PROP_NAME` Channel for sending messages to a cluster.
`static String`	`INGRESS_ENDPOINTS_DEFAULT` Default comma separated list of cluster ingress endpoints.
`static String`	`INGRESS_ENDPOINTS_PROP_NAME` Property name for the comma separated list of cluster ingress endpoints for use with unicast.
`static int`	`INGRESS_STREAM_ID_DEFAULT` Default stream id within a channel for sending messages to a cluster.
`static String`	`INGRESS_STREAM_ID_PROP_NAME` Stream id within a channel for sending messages to a cluster.
`static long`	`MESSAGE_TIMEOUT_DEFAULT_NS` Default timeout when waiting on a message to be sent or received.
`static String`	`MESSAGE_TIMEOUT_PROP_NAME` Timeout when waiting on a message to be sent or received.
`static int`	`PROTOCOL_MAJOR_VERSION` Major version of the network protocol from client to consensus module.
`static int`	`PROTOCOL_MINOR_VERSION` Minor version of the network protocol from client to consensus module.
`static int`	`PROTOCOL_PATCH_VERSION` Patch version of the network protocol from client to consensus module.
`static int`	`PROTOCOL_SEMANTIC_VERSION` Combined semantic version for the client to consensus module protocol.

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`	`egressChannel()` The value `EGRESS_CHANNEL_DEFAULT` or system property `EGRESS_CHANNEL_PROP_NAME` if set.
`static int`	`egressStreamId()` The value `EGRESS_STREAM_ID_DEFAULT` or system property `EGRESS_STREAM_ID_PROP_NAME` if set.
`static String`	`ingressChannel()` The value `INGRESS_CHANNEL_DEFAULT` or system property `INGRESS_CHANNEL_PROP_NAME` if set.
`static String`	`ingressEndpoints()` The value `INGRESS_ENDPOINTS_DEFAULT` or system property `INGRESS_ENDPOINTS_PROP_NAME` if set.
`static int`	`ingressStreamId()` The value `INGRESS_STREAM_ID_DEFAULT` or system property `INGRESS_STREAM_ID_PROP_NAME` if set.
`static long`	`messageTimeoutNs()` The timeout in nanoseconds to wait for a message.

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 consensus module. If these don't match then client and archive consensus module 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 consensus module. 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 consensus module. 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 client to consensus module protocol.
    
    See Also:
    
    SemanticVersion
  - MESSAGE_TIMEOUT_PROP_NAME
```
public static final String MESSAGE_TIMEOUT_PROP_NAME
```
    Timeout 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
```
    Default timeout when waiting on a message to be sent or received.
  - INGRESS_ENDPOINTS_PROP_NAME
```
public static final String INGRESS_ENDPOINTS_PROP_NAME
```
    Property name for the comma separated list of cluster ingress endpoints for use with unicast. This is the endpoint values which get substituted into the INGRESS_CHANNEL_PROP_NAME when using UDP unicast.
    "0=endpoint,1=endpoint,2=endpoint"
    Each member of the list will be substituted for the endpoint in the INGRESS_CHANNEL_PROP_NAME value.
    
    See Also:
    
    Constant Field Values
  - INGRESS_ENDPOINTS_DEFAULT
```
public static final String INGRESS_ENDPOINTS_DEFAULT
```
    Default comma separated list of cluster ingress endpoints.
  - INGRESS_CHANNEL_PROP_NAME
```
public static final String INGRESS_CHANNEL_PROP_NAME
```
    Channel for sending messages to a cluster. Ideally this will be a multicast address otherwise unicast will be required and the INGRESS_ENDPOINTS_PROP_NAME is used to substitute the endpoints from the INGRESS_ENDPOINTS_PROP_NAME list.
    
    See Also:
    
    Constant Field Values
  - INGRESS_CHANNEL_DEFAULT
```
public static final String INGRESS_CHANNEL_DEFAULT
```
    Channel for sending messages to a cluster.
  - INGRESS_STREAM_ID_PROP_NAME
```
public static final String INGRESS_STREAM_ID_PROP_NAME
```
    Stream id within a channel for sending messages to a cluster.
    
    See Also:
    
    Constant Field Values
  - INGRESS_STREAM_ID_DEFAULT
```
public static final int INGRESS_STREAM_ID_DEFAULT
```
    Default stream id within a channel for sending messages to a cluster.
    
    See Also:
    
    Constant Field Values
  - EGRESS_CHANNEL_PROP_NAME
```
public static final String EGRESS_CHANNEL_PROP_NAME
```
    Channel for receiving response messages from a cluster.
    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:9020 - listen on port 9020 on localhost.
    - aeron:udp?endpoint=192.168.10.10:9020 - listen on port 9020 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
  - EGRESS_CHANNEL_DEFAULT
```
public static final String EGRESS_CHANNEL_DEFAULT
```
    Channel for receiving response messages from a cluster.
    
    See Also:
    
    Constant Field Values
  - EGRESS_STREAM_ID_PROP_NAME
```
public static final String EGRESS_STREAM_ID_PROP_NAME
```
    Stream id within a channel for receiving messages from a cluster.
    
    See Also:
    
    Constant Field Values
  - EGRESS_STREAM_ID_DEFAULT
```
public static final int EGRESS_STREAM_ID_DEFAULT
```
    Default stream id within a channel for receiving messages from a cluster.
    
    See Also:
    
    Constant Field Values
- 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
  - ingressEndpoints
```
public static String ingressEndpoints()
```
    The value INGRESS_ENDPOINTS_DEFAULT or system property INGRESS_ENDPOINTS_PROP_NAME if set.
    
    Returns:
    
    INGRESS_ENDPOINTS_DEFAULT or system property INGRESS_ENDPOINTS_PROP_NAME if set.
  - ingressChannel
```
public static String ingressChannel()
```
    The value INGRESS_CHANNEL_DEFAULT or system property INGRESS_CHANNEL_PROP_NAME if set.
    
    Returns:
    
    INGRESS_CHANNEL_DEFAULT or system property INGRESS_CHANNEL_PROP_NAME if set.
  - ingressStreamId
```
public static int ingressStreamId()
```
    The value INGRESS_STREAM_ID_DEFAULT or system property INGRESS_STREAM_ID_PROP_NAME if set.
    
    Returns:
    
    INGRESS_STREAM_ID_DEFAULT or system property INGRESS_STREAM_ID_PROP_NAME if set.
  - egressChannel
```
public static String egressChannel()
```
    The value EGRESS_CHANNEL_DEFAULT or system property EGRESS_CHANNEL_PROP_NAME if set.
    
    Returns:
    
    EGRESS_CHANNEL_DEFAULT or system property EGRESS_CHANNEL_PROP_NAME if set.
  - egressStreamId
```
public static int egressStreamId()
```
    The value EGRESS_STREAM_ID_DEFAULT or system property EGRESS_STREAM_ID_PROP_NAME if set.
    
    Returns:
    
    EGRESS_STREAM_ID_DEFAULT or system property EGRESS_STREAM_ID_PROP_NAME if set.

Class AeronCluster.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

INGRESS_ENDPOINTS_PROP_NAME

INGRESS_ENDPOINTS_DEFAULT

INGRESS_CHANNEL_PROP_NAME

INGRESS_CHANNEL_DEFAULT

INGRESS_STREAM_ID_PROP_NAME

INGRESS_STREAM_ID_DEFAULT

EGRESS_CHANNEL_PROP_NAME

EGRESS_CHANNEL_DEFAULT

EGRESS_STREAM_ID_PROP_NAME

EGRESS_STREAM_ID_DEFAULT

Constructor Detail

Configuration

Method Detail

messageTimeoutNs

ingressEndpoints

ingressChannel

ingressStreamId

egressChannel

egressStreamId