io.aeron.cluster.client

Class AeronCluster.Context

java.lang.Object

io.aeron.cluster.client.AeronCluster.Context

All Implemented Interfaces:

Cloneable

Enclosing class:

AeronCluster

public static final class AeronCluster.Context
extends Object
implements Cloneable

Context for cluster session and connection.

Constructor Summary

Constructors

Constructor and Description
Context()

Method Summary

Modifier and Type	Method and Description
Aeron	aeron() Aeron client for communicating with the local Media Driver.
AeronCluster.Context	aeron(Aeron aeron) Aeron client for communicating with the local Media Driver.
String	aeronDirectoryName() Get the top level Aeron directory used for communication between the Aeron client and Media Driver.
AeronCluster.Context	aeronDirectoryName(String aeronDirectoryName) Set the top level Aeron directory used for communication between the Aeron client and Media Driver.
AgentInvoker	agentInvoker() Get the AgentInvoker to be invoked in addition to any invoker used by the aeron() instance.
AeronCluster.Context	agentInvoker(AgentInvoker agentInvoker) Set the AgentInvoker to be invoked in addition to any invoker used by the aeron() instance.
AeronCluster.Context	clone() Perform a shallow copy of the object.
void	close() Close the context and free applicable resources.
void	conclude() Conclude configuration by setting up defaults when specifics are not provided.
ControlledEgressListener	controlledEgressListener() Get the ControlledEgressListener function that will be called when polling for egress via AeronCluster.controlledPollEgress().
AeronCluster.Context	controlledEgressListener(ControlledEgressListener listener) Set the ControlledEgressListener function that will be called when polling for egress via AeronCluster.controlledPollEgress().
CredentialsSupplier	credentialsSupplier() Get the CredentialsSupplier to be used for authentication with the cluster.
AeronCluster.Context	credentialsSupplier(CredentialsSupplier credentialsSupplier) Set the CredentialsSupplier to be used for authentication with the cluster.
String	egressChannel() Get the channel parameter for the egress channel.
AeronCluster.Context	egressChannel(String channel) Set the channel parameter for the egress channel.
EgressListener	egressListener() Get the EgressListener function that will be called when polling for egress via AeronCluster.pollEgress().
AeronCluster.Context	egressListener(EgressListener listener) Set the EgressListener function that will be called when polling for egress via AeronCluster.pollEgress().
int	egressStreamId() Get the stream id for the egress channel.
AeronCluster.Context	egressStreamId(int streamId) Set the stream id for the egress channel.
ErrorHandler	errorHandler() Get the ErrorHandler to be used for handling any exceptions.
AeronCluster.Context	errorHandler(ErrorHandler errorHandler) Set the ErrorHandler to be used for handling any exceptions.
IdleStrategy	idleStrategy() Get the IdleStrategy used when waiting for responses.
AeronCluster.Context	idleStrategy(IdleStrategy idleStrategy) Set the IdleStrategy used when waiting for responses.
String	ingressChannel() Get the channel parameter for the ingress channel.
AeronCluster.Context	ingressChannel(String channel) Set the channel parameter for the ingress channel.
String	ingressEndpoints() The endpoints representing members for use with unicast to be substituted into the ingressChannel() for endpoints.
AeronCluster.Context	ingressEndpoints(String clusterMembers) The endpoints representing members for use with unicast to be substituted into the ingressChannel() for endpoints.
int	ingressStreamId() Get the stream id for the ingress channel.
AeronCluster.Context	ingressStreamId(int streamId) Set the stream id for the ingress channel.
boolean	isDirectAssemblers() Are direct buffers used for fragment assembly on egress?
AeronCluster.Context	isDirectAssemblers(boolean isDirectAssemblers) Are direct buffers used for fragment assembly on egress?
boolean	isIngressExclusive() Is ingress the Publication to the cluster used exclusively from a single thread to this client?
AeronCluster.Context	isIngressExclusive(boolean isIngressExclusive) Is ingress to the cluster exclusively from a single thread to this client? The client should not be used from another thread, e.g.
long	messageTimeoutNs() The message timeout in nanoseconds to wait for sending or receiving a message.
AeronCluster.Context	messageTimeoutNs(long messageTimeoutNs) Set the message timeout in nanoseconds to wait for sending or receiving a message.
boolean	ownsAeronClient() Does this context own the aeron() client and this takes responsibility for closing it?
AeronCluster.Context	ownsAeronClient(boolean ownsAeronClient) Does this context own the aeron() client and this takes responsibility for closing it?
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 AeronCluster.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.

messageTimeoutNs

public AeronCluster.Context messageTimeoutNs(long messageTimeoutNs)

Set the message timeout in nanoseconds to wait for sending or receiving a message.

Parameters:

messageTimeoutNs - to wait for sending or receiving a message.

Returns:

this for a fluent API.

See Also:

AeronCluster.Configuration.MESSAGE_TIMEOUT_PROP_NAME

messageTimeoutNs

public long messageTimeoutNs()

The message timeout in nanoseconds to wait for sending or receiving a message.

Returns:

the message timeout in nanoseconds to wait for sending or receiving a message.

See Also:

AeronCluster.Configuration.MESSAGE_TIMEOUT_PROP_NAME

ingressEndpoints

public AeronCluster.Context ingressEndpoints(String clusterMembers)

The endpoints representing members for use with unicast to be substituted into the ingressChannel() for endpoints. A null value can be used when multicast where the ingressChannel() contains the multicast endpoint.

Parameters:

clusterMembers - which are all candidates to be leader.

Returns:

this for a fluent API.

See Also:

AeronCluster.Configuration.INGRESS_ENDPOINTS_PROP_NAME

ingressEndpoints

public String ingressEndpoints()

The endpoints representing members for use with unicast to be substituted into the ingressChannel() for endpoints. A null value can be used when multicast where the ingressChannel() contains the multicast endpoint.

Returns:

member endpoints of the cluster which are all candidates to be leader.

See Also:

AeronCluster.Configuration.INGRESS_ENDPOINTS_PROP_NAME

ingressChannel

public AeronCluster.Context ingressChannel(String channel)

Set the channel parameter for the ingress channel.

The endpoints representing members for use with unicast are substituted from ingressEndpoints() for endpoints. If this channel contains a multicast endpoint, then ingressEndpoints() should be set to null.

Parameters:

channel - parameter for the ingress channel.

Returns:

this for a fluent API.

See Also:

AeronCluster.Configuration.INGRESS_CHANNEL_PROP_NAME

ingressChannel

public String ingressChannel()

Get the channel parameter for the ingress channel.

The endpoints representing members for use with unicast are substituted from ingressEndpoints() for endpoints. A null value can be used when multicast where this contains the multicast endpoint.

Returns:

the channel parameter for the ingress channel.

See Also:

AeronCluster.Configuration.INGRESS_CHANNEL_PROP_NAME

ingressStreamId

public AeronCluster.Context ingressStreamId(int streamId)

Set the stream id for the ingress channel.

Parameters:

streamId - for the ingress channel.

Returns:

this for a fluent API

See Also:

AeronCluster.Configuration.INGRESS_STREAM_ID_PROP_NAME

ingressStreamId

public int ingressStreamId()

Get the stream id for the ingress channel.

Returns:

the stream id for the ingress channel.

See Also:

AeronCluster.Configuration.INGRESS_STREAM_ID_PROP_NAME

egressChannel

public AeronCluster.Context egressChannel(String channel)

Set the channel parameter for the egress channel.

Parameters:

channel - parameter for the egress channel.

Returns:

this for a fluent API.

See Also:

AeronCluster.Configuration.EGRESS_CHANNEL_PROP_NAME

egressChannel

public String egressChannel()

Get the channel parameter for the egress channel.

Returns:

the channel parameter for the egress channel.

See Also:

AeronCluster.Configuration.EGRESS_CHANNEL_PROP_NAME

egressStreamId

public AeronCluster.Context egressStreamId(int streamId)

Set the stream id for the egress channel.

Parameters:

streamId - for the egress channel.

Returns:

this for a fluent API

See Also:

AeronCluster.Configuration.EGRESS_STREAM_ID_PROP_NAME

egressStreamId

public int egressStreamId()

Get the stream id for the egress channel.

Returns:

the stream id for the egress channel.

See Also:

AeronCluster.Configuration.EGRESS_STREAM_ID_PROP_NAME

idleStrategy

public AeronCluster.Context idleStrategy(IdleStrategy idleStrategy)

Set the IdleStrategy used when waiting for responses.

Parameters:

idleStrategy - used when waiting for responses.

Returns:

this for a fluent API.

idleStrategy

public IdleStrategy idleStrategy()

Get the IdleStrategy used when waiting for responses.

Returns:

the IdleStrategy used when waiting for responses.

aeronDirectoryName

public AeronCluster.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 AeronCluster.Context aeron(Aeron aeron)

Aeron client for communicating with the local Media Driver.

This client will be closed when the AeronCluster.close() or close() methods are called if ownsAeronClient() is true.

Parameters:

aeron - client for communicating with the local Media Driver.

Returns:

this for a fluent API.

See Also:

Aeron.connect()

aeron

public Aeron aeron()

Aeron client for communicating with the local Media Driver.

If not provided then a default will be established during conclude() by calling Aeron.connect().

Returns:

client for communicating with the local Media Driver.

ownsAeronClient

public AeronCluster.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?

isIngressExclusive

public AeronCluster.Context isIngressExclusive(boolean isIngressExclusive)

Is ingress to the cluster exclusively from a single thread to this client? The client should not be used from another thread, e.g. a separate thread calling AeronCluster.sendKeepAlive() - which is awful design by the way!

Parameters:

isIngressExclusive - true if ingress to the cluster is exclusively from a single thread for this client?

Returns:

this for a fluent API.

isIngressExclusive

public boolean isIngressExclusive()

Is ingress the Publication to the cluster used exclusively from a single thread to this client?

Returns:

true if the ingress Publication is to be used exclusively from a single thread?

credentialsSupplier

public AeronCluster.Context credentialsSupplier(CredentialsSupplier credentialsSupplier)

Set the CredentialsSupplier to be used for authentication with the cluster.

Parameters:

credentialsSupplier - to be used for authentication with the cluster.

Returns:

this for fluent API.

credentialsSupplier

public CredentialsSupplier credentialsSupplier()

Get the CredentialsSupplier to be used for authentication with the cluster.

Returns:

the CredentialsSupplier to be used for authentication with the cluster.

errorHandler

public AeronCluster.Context errorHandler(ErrorHandler errorHandler)

Set the ErrorHandler to be used for handling any exceptions.

Parameters:

errorHandler - Method to handle objects of type Throwable.

Returns:

this for fluent API.

errorHandler

public ErrorHandler errorHandler()

Get the ErrorHandler to be used for handling any exceptions.

Returns:

The ErrorHandler to be used for handling any exceptions.

isDirectAssemblers

public AeronCluster.Context isDirectAssemblers(boolean isDirectAssemblers)

Are direct buffers used for fragment assembly on egress?

Parameters:

isDirectAssemblers - true if direct buffers used for fragment assembly on egress.

Returns:

this for a fluent API.

isDirectAssemblers

public boolean isDirectAssemblers()

Are direct buffers used for fragment assembly on egress?

Returns:

true if direct buffers used for fragment assembly on egress.

egressListener

public AeronCluster.Context egressListener(EgressListener listener)

Set the EgressListener function that will be called when polling for egress via AeronCluster.pollEgress().

Only EgressListener.onMessage(long, long, DirectBuffer, int, int, Header) will be dispatched when using AeronCluster.pollEgress().

Parameters:

listener - function that will be called when polling for egress via AeronCluster.pollEgress().

Returns:

this for a fluent API.

egressListener

public EgressListener egressListener()

Get the EgressListener function that will be called when polling for egress via AeronCluster.pollEgress().

Returns:

the EgressListener function that will be called when polling for egress via AeronCluster.pollEgress().

controlledEgressListener

public AeronCluster.Context controlledEgressListener(ControlledEgressListener listener)

Set the ControlledEgressListener function that will be called when polling for egress via AeronCluster.controlledPollEgress().

Only ControlledEgressListener.onMessage(long, long, DirectBuffer, int, int, Header) will be dispatched when using AeronCluster.controlledPollEgress().

Parameters:

listener - function that will be called when polling for egress via AeronCluster.controlledPollEgress().

Returns:

this for a fluent API.

controlledEgressListener

public ControlledEgressListener controlledEgressListener()

Get the ControlledEgressListener function that will be called when polling for egress via AeronCluster.controlledPollEgress().

Returns:

the ControlledEgressListener function that will be called when polling for egress via AeronCluster.controlledPollEgress().

agentInvoker

public AeronCluster.Context agentInvoker(AgentInvoker agentInvoker)

Set the AgentInvoker to be invoked in addition to any invoker used by the aeron() instance.

Useful for when running on a low thread count scenario.

Parameters:

agentInvoker - to be invoked while awaiting a response in the client or when awaiting completion.

Returns:

this for a fluent API.

agentInvoker

public AgentInvoker agentInvoker()

Get the AgentInvoker to be invoked in addition to any invoker used by the aeron() instance.

Returns:

the AgentInvoker that is used.

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