io.aeron

Class Aeron.Context

java.lang.Object

io.aeron.CommonContext

io.aeron.Aeron.Context

All Implemented Interfaces:

java.lang.AutoCloseable

Enclosing class:

Aeron

public static class Aeron.Context
extends CommonContext

This class provides configuration for the Aeron class via the Aeron.connect(Aeron.Context) method and its overloads. It gives applications some control over the interactions with the Aeron Media Driver. It can also set up error handling as well as application callbacks for image information from the Media Driver.

Field Summary

Fields inherited from class io.aeron.CommonContext

AERON_DIR_PROP_DEFAULT, AERON_DIR_PROP_NAME, DEFAULT_DRIVER_TIMEOUT_MS, IPC_CHANNEL, SPY_PREFIX, TERM_LENGTH_PARAM_NAME

Constructor Summary

Constructors

Constructor and Description
Context()

Method Summary

Modifier and Type	Method and Description
Aeron.Context	aeronDirectoryName(java.lang.String dirName) Set the top level Aeron directory used for communication between the client and Media Driver, and the location of the data buffers.
Aeron.Context	availableImageHandler(AvailableImageHandler handler) Set up a callback for when an Image is available.
Aeron.Context	bufferManager(io.aeron.LogBuffersFactory logBuffersFactory) This method is used for testing and debugging.
void	close() Clean up all resources that the client uses to communicate with the Media Driver.
Aeron.Context	conclude() This is called automatically by Aeron.connect(Aeron.Context) and its overloads.
Aeron.Context	driverTimeoutMs(long value) Set the amount of time, in milliseconds, that this client will wait until it determines the Media Driver is unavailable.
Aeron.Context	epochClock(org.agrona.concurrent.EpochClock clock) Set the EpochClock to be used for tracking wall clock time when interacting with the driver.
Aeron.Context	errorHandler(org.agrona.ErrorHandler errorHandler) Handle Aeron exceptions in a callback method.
Aeron.Context	idleStrategy(org.agrona.concurrent.IdleStrategy idleStrategy) Provides an IdleStrategy for the thread responsible for communicating with the Aeron Media Driver.
Aeron.Context	imageMapMode(java.nio.channels.FileChannel.MapMode imageMapMode) The file memory mapping mode for Images.
long	interServiceTimeout() Return the timeout between service calls for the client.
long	keepAliveInterval() Get the interval in nanoseconds for which the client will perform keep-alive operations.
Aeron.Context	keepAliveInterval(long value) Set the interval in nanoseconds for which the client will perform keep-alive operations.
Aeron.Context	nanoClock(org.agrona.concurrent.NanoClock clock) Set the NanoClock to be used for tracking high resolution time.
long	publicationConnectionTimeout() Return the timeout, in milliseconds, that this client will use to determine if a Publication has active subscribers or not.
Aeron.Context	publicationConnectionTimeout(long value) Set the amount of time, in milliseconds, that this client will use to determine if a Publication has active subscribers or not.
java.util.concurrent.ThreadFactory	threadFactory() The thread factory to be use to construct the conductor thread
Aeron.Context	threadFactory(java.util.concurrent.ThreadFactory threadFactory) Specify the thread factory to use when starting the conductor thread.
Aeron.Context	toClientBuffer(org.agrona.concurrent.broadcast.CopyBroadcastReceiver toClientBuffer) This method is used for testing and debugging.
Aeron.Context	toDriverBuffer(org.agrona.concurrent.ringbuffer.RingBuffer toDriverBuffer) This method is used for testing and debugging.
Aeron.Context	unavailableImageHandler(UnavailableImageHandler handler) Set up a callback for when an Image is unavailable.

Methods inherited from class io.aeron.CommonContext

aeronDirectoryName, cncFile, countersMetaDataBuffer, countersMetaDataBuffer, countersValuesBuffer, countersValuesBuffer, deleteAeronDirectory, driverTimeoutMs, generateRandomDirName, isDriverActive, newDefaultCncFile, saveErrorLog

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Context

public Context()

Method Detail

conclude

public Aeron.Context conclude()

This is called automatically by Aeron.connect(Aeron.Context) and its overloads. There is no need to call it from a client application. It is responsible for providing default values for options that are not individually changed through field setters.

Overrides:

conclude in class CommonContext

Returns:

this Aeron.Context for method chaining.

epochClock

public Aeron.Context epochClock(org.agrona.concurrent.EpochClock clock)

Set the EpochClock to be used for tracking wall clock time when interacting with the driver.

Parameters:

clock - EpochClock to be used for tracking wall clock time when interacting with the driver.

Returns:

this Aeron.Context for method chaining

nanoClock

public Aeron.Context nanoClock(org.agrona.concurrent.NanoClock clock)

Set the NanoClock to be used for tracking high resolution time.

Parameters:

clock - NanoClock to be used for tracking high resolution time.

Returns:

this Aeron.Context for method chaining

idleStrategy

public Aeron.Context idleStrategy(org.agrona.concurrent.IdleStrategy idleStrategy)

Provides an IdleStrategy for the thread responsible for communicating with the Aeron Media Driver.

Parameters:

idleStrategy - Thread idle strategy for communication with the Media Driver.

Returns:

this Aeron.Context for method chaining.

toClientBuffer

public Aeron.Context toClientBuffer(org.agrona.concurrent.broadcast.CopyBroadcastReceiver toClientBuffer)

This method is used for testing and debugging.

Parameters:

toClientBuffer - Injected CopyBroadcastReceiver

Returns:

this Aeron.Context for method chaining.

toDriverBuffer

public Aeron.Context toDriverBuffer(org.agrona.concurrent.ringbuffer.RingBuffer toDriverBuffer)

This method is used for testing and debugging.

Parameters:

toDriverBuffer - Injected RingBuffer.

Returns:

this Aeron.Context for method chaining.

bufferManager

public Aeron.Context bufferManager(io.aeron.LogBuffersFactory logBuffersFactory)

This method is used for testing and debugging.

Parameters:

logBuffersFactory - Injected LogBuffersFactory

Returns:

this Aeron.Context for method chaining.

errorHandler

public Aeron.Context errorHandler(org.agrona.ErrorHandler errorHandler)

Handle Aeron exceptions in a callback method. The default behavior is defined by Aeron.DEFAULT_ERROR_HANDLER.

Parameters:

errorHandler - Method to handle objects of type Throwable.

Returns:

this Aeron.Context for method chaining.

See Also:

DriverTimeoutException, RegistrationException

availableImageHandler

public Aeron.Context availableImageHandler(AvailableImageHandler handler)

Set up a callback for when an Image is available.

Parameters:

handler - Callback method for handling available image notifications.

Returns:

this Aeron.Context for method chaining.

unavailableImageHandler

public Aeron.Context unavailableImageHandler(UnavailableImageHandler handler)

Set up a callback for when an Image is unavailable.

Parameters:

handler - Callback method for handling unavailable image notifications.

Returns:

this Aeron.Context for method chaining.

keepAliveInterval

public Aeron.Context keepAliveInterval(long value)

Set the interval in nanoseconds for which the client will perform keep-alive operations.

Parameters:

value - the interval in nanoseconds for which the client will perform keep-alive operations.

Returns:

this Aeron.Context for method chaining.

keepAliveInterval

public long keepAliveInterval()

Get the interval in nanoseconds for which the client will perform keep-alive operations.

Returns:

the interval in nanoseconds for which the client will perform keep-alive operations.

driverTimeoutMs

public Aeron.Context driverTimeoutMs(long value)

Set the amount of time, in milliseconds, that this client will wait until it determines the Media Driver is unavailable. When this happens a DriverTimeoutException will be generated for the error handler.

Overrides:

driverTimeoutMs in class CommonContext

Parameters:

value - Number of milliseconds.

Returns:

this Aeron.Context for method chaining.

See Also:

errorHandler(ErrorHandler)

interServiceTimeout

public long interServiceTimeout()

Return the timeout between service calls for the client. When exceeded, errorHandler will be called and the active Publications and Images closed. This value is controlled by the driver and included in the CnC file.

Returns:

the timeout between service calls in nanoseconds.

aeronDirectoryName

public Aeron.Context aeronDirectoryName(java.lang.String dirName)

Description copied from class: CommonContext

Set the top level Aeron directory used for communication between the client and Media Driver, and the location of the data buffers.

Overrides:

aeronDirectoryName in class CommonContext

Parameters:

dirName - New top level Aeron directory.

Returns:

this Object for method chaining.

See Also:

CommonContext.aeronDirectoryName(String)

publicationConnectionTimeout

public Aeron.Context publicationConnectionTimeout(long value)

Set the amount of time, in milliseconds, that this client will use to determine if a Publication has active subscribers or not.

Parameters:

value - number of milliseconds.

Returns:

this Aeron.Context for method chaining.

publicationConnectionTimeout

public long publicationConnectionTimeout()

Return the timeout, in milliseconds, that this client will use to determine if a Publication has active subscribers or not.

Returns:

timeout in milliseconds.

imageMapMode

public Aeron.Context imageMapMode(java.nio.channels.FileChannel.MapMode imageMapMode)

The file memory mapping mode for Images.

Parameters:

imageMapMode - file memory mapping mode for Images.

Returns:

this for a fluent API.

threadFactory

public Aeron.Context threadFactory(java.util.concurrent.ThreadFactory threadFactory)

Specify the thread factory to use when starting the conductor thread.

Parameters:

threadFactory - thread factory to construct the thread.

Returns:

this for a fluent API.

threadFactory

public java.util.concurrent.ThreadFactory threadFactory()

The thread factory to be use to construct the conductor thread

Returns:

the specified thread factory or Thread.Thread(Runnable) if none is provided

close

public void close()

Clean up all resources that the client uses to communicate with the Media Driver.

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class CommonContext