io.aeron.cluster.client

Class AeronCluster.Configuration

java.lang.Object

io.aeron.cluster.client.AeronCluster.Configuration

Enclosing class:

AeronCluster

public static class AeronCluster.Configuration
extends Object

Configuration options for cluster client.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLUSTER_MEMBER_ENDPOINTS_DEFAULT Default comma separated list of cluster member endpoints.
static String	CLUSTER_MEMBER_ENDPOINTS_PROP_NAME Property name for the comma separated list of cluster member endpoints for use with unicast.
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 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
static int	PROTOCOL_MINOR_VERSION
static int	PROTOCOL_PATCH_VERSION
static int	PROTOCOL_SEMANTIC_VERSION

Constructor Summary

Constructors

Constructor and Description
Configuration()

Method Summary

Modifier and Type	Method and Description
static String	clusterMemberEndpoints() The value CLUSTER_MEMBER_ENDPOINTS_DEFAULT or system property CLUSTER_MEMBER_ENDPOINTS_PROP_NAME if set.
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 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

See Also:

Constant Field Values

PROTOCOL_MINOR_VERSION

public static final int PROTOCOL_MINOR_VERSION

See Also:

Constant Field Values

PROTOCOL_PATCH_VERSION

public static final int PROTOCOL_PATCH_VERSION

See Also:

Constant Field Values

PROTOCOL_SEMANTIC_VERSION

public static final int PROTOCOL_SEMANTIC_VERSION

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.

CLUSTER_MEMBER_ENDPOINTS_PROP_NAME

public static final String CLUSTER_MEMBER_ENDPOINTS_PROP_NAME

Property name for the comma separated list of cluster member 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

CLUSTER_MEMBER_ENDPOINTS_DEFAULT

public static final String CLUSTER_MEMBER_ENDPOINTS_DEFAULT

Default comma separated list of cluster member 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 CLUSTER_MEMBER_ENDPOINTS_PROP_NAME is used to substitute the endpoints from the CLUSTER_MEMBER_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.

See Also:

Constant Field Values

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.

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

clusterMemberEndpoints

public static String clusterMemberEndpoints()

The value CLUSTER_MEMBER_ENDPOINTS_DEFAULT or system property CLUSTER_MEMBER_ENDPOINTS_PROP_NAME if set.

Returns:

CLUSTER_MEMBER_ENDPOINTS_DEFAULT or system property CLUSTER_MEMBER_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.