Aeron.Context (Aeron Transport Protocol)

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. A number of the properties are for testing and should not be set by end users.

Field Summary
- Fields inherited from class io.aeron.CommonContext
  AERON_DIR_PROP_DEFAULT, AERON_DIR_PROP_NAME, DEFAULT_DRIVER_TIMEOUT_MS, INITIAL_TERM_ID_PARAM_NAME, IPC_CHANNEL, MDC_CONTROL_MODE, MDC_CONTROL_MODE_MANUAL, MTU_LENGTH_URI_PARAM_NAME, RELIABLE_STREAM_PARAM_NAME, SPY_PREFIX, TERM_ID_PARAM_NAME, TERM_LENGTH_PARAM_NAME, TERM_OFFSET_PARAM_NAME

Constructor Summary

Constructors
Constructor and Description

Context()

Constructors
Constructor and Description
`Context()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`AvailableImageHandler`	`availableImageHandler()` Get the default callback handler for notifying when `Image`s become available.
`Aeron.Context`	`availableImageHandler(AvailableImageHandler handler)` Setup a default callback for when an `Image` is available.
`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.
`DriverProxy`	`driverProxy()` Get the proxy for communicating with the media driver.
`Aeron.Context`	`driverProxy(DriverProxy driverProxy)` Set the proxy for communicating with the media driver.
`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.
`org.agrona.concurrent.EpochClock`	`epochClock()` Get the `Clock` used by the client for the epoch time in milliseconds.
`Aeron.Context`	`epochClock(org.agrona.concurrent.EpochClock clock)` Set the `EpochClock` to be used for tracking wall clock time when interacting with the driver.
`org.agrona.ErrorHandler`	`errorHandler()` Get the error handler that will be called for errors reported back from the media driver.
`Aeron.Context`	`errorHandler(org.agrona.ErrorHandler errorHandler)` Handle Aeron exceptions in a callback method.
`org.agrona.concurrent.IdleStrategy`	`idleStrategy()` Get the `IdleStrategy` employed by the client conductor thread.
`Aeron.Context`	`idleStrategy(org.agrona.concurrent.IdleStrategy idleStrategy)` Provides an IdleStrategy for the thread responsible for communicating with the Aeron Media Driver.
`java.nio.channels.FileChannel.MapMode`	`imageMapMode()` The file memory mapping mode for `Image`s.
`Aeron.Context`	`imageMapMode(java.nio.channels.FileChannel.MapMode imageMapMode)` The file memory mapping mode for `Image`s.
`long`	`interServiceTimeout()` Return the timeout between service calls to the duty cycle for the client.
`Aeron.Context`	`interServiceTimeout(long interServiceTimeout)` Set the timeout between service calls the to `ClientConductor` duty cycles.
`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.
`io.aeron.LogBuffersFactory`	`logBuffersFactory()` Get the factory for making log buffers.
`Aeron.Context`	`logBuffersFactory(io.aeron.LogBuffersFactory logBuffersFactory)` This method is used for testing and debugging.
`org.agrona.concurrent.NanoClock`	`nanoClock()` Get the `NanoClock` to be used for tracking high resolution time.
`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.
`org.agrona.concurrent.broadcast.CopyBroadcastReceiver`	`toClientBuffer()` The buffer used for communicating from the media driver to the Aeron client.
`Aeron.Context`	`toClientBuffer(org.agrona.concurrent.broadcast.CopyBroadcastReceiver toClientBuffer)` This method is used for testing and debugging.
`org.agrona.concurrent.ringbuffer.RingBuffer`	`toDriverBuffer()` Get the `RingBuffer` used for sending commands to the media driver.
`Aeron.Context`	`toDriverBuffer(org.agrona.concurrent.ringbuffer.RingBuffer toDriverBuffer)` This method is used for testing and debugging.
`UnavailableImageHandler`	`unavailableImageHandler()` Get the callback handler for when an `Image` is unavailable.
`Aeron.Context`	`unavailableImageHandler(UnavailableImageHandler handler)` Setup a default callback for when an `Image` is unavailable.

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
  - epochClock
```
public org.agrona.concurrent.EpochClock epochClock()
```
    Get the Clock used by the client for the epoch time in milliseconds.
    
    Returns:
    
    the Clock used by the client for the epoch time in milliseconds.
  - 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
  - nanoClock
```
public org.agrona.concurrent.NanoClock nanoClock()
```
    Get the NanoClock to be used for tracking high resolution time.
    
    Returns:
    
    the NanoClock to be used for tracking high resolution time.
  - 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.
  - idleStrategy
```
public org.agrona.concurrent.IdleStrategy idleStrategy()
```
    Get the IdleStrategy employed by the client conductor thread.
    
    Returns:
    
    the IdleStrategy employed by the client conductor thread.
  - 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.
  - toClientBuffer
```
public org.agrona.concurrent.broadcast.CopyBroadcastReceiver toClientBuffer()
```
    The buffer used for communicating from the media driver to the Aeron client.
    
    Returns:
    
    the buffer used for communicating from the media driver to the Aeron client.
  - 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.
  - toDriverBuffer
```
public org.agrona.concurrent.ringbuffer.RingBuffer toDriverBuffer()
```
    Get the RingBuffer used for sending commands to the media driver.
    
    Returns:
    
    the RingBuffer used for sending commands to the media driver.
  - driverProxy
```
public Aeron.Context driverProxy(DriverProxy driverProxy)
```
    Set the proxy for communicating with the media driver.
    
    Parameters:
    
    driverProxy - for communicating with the media driver.
    
    Returns:
    
    this Aeron.Context for method chaining.
  - driverProxy
```
public DriverProxy driverProxy()
```
    Get the proxy for communicating with the media driver.
    
    Returns:
    
    the proxy for communicating with the media driver.
  - logBuffersFactory
```
public Aeron.Context logBuffersFactory(io.aeron.LogBuffersFactory logBuffersFactory)
```
    This method is used for testing and debugging.
    
    Parameters:
    
    logBuffersFactory - Injected LogBuffersFactory
    
    Returns:
    
    this Aeron.Context for method chaining.
  - logBuffersFactory
```
public io.aeron.LogBuffersFactory logBuffersFactory()
```
    Get the factory for making log buffers.
    
    Returns:
    
    the factory for making log buffers.
  - 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
  - errorHandler
```
public org.agrona.ErrorHandler errorHandler()
```
    Get the error handler that will be called for errors reported back from the media driver.
    
    Returns:
    
    the error handler that will be called for errors reported back from the media driver.
  - availableImageHandler
```
public Aeron.Context availableImageHandler(AvailableImageHandler handler)
```
    Setup a default callback for when an Image is available.
    
    Parameters:
    
    handler - Callback method for handling available image notifications.
    
    Returns:
    
    this Aeron.Context for method chaining.
  - availableImageHandler
```
public AvailableImageHandler availableImageHandler()
```
    Get the default callback handler for notifying when Images become available.
    
    Returns:
    
    the callback handler for notifying when Images become available.
  - unavailableImageHandler
```
public Aeron.Context unavailableImageHandler(UnavailableImageHandler handler)
```
    Setup a default callback for when an Image is unavailable.
    
    Parameters:
    
    handler - Callback method for handling unavailable image notifications.
    
    Returns:
    
    this Aeron.Context for method chaining.
  - unavailableImageHandler
```
public UnavailableImageHandler unavailableImageHandler()
```
    Get the callback handler for when an Image is unavailable.
    
    Returns:
    
    the callback handler for when an Image is unavailable.
  - 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 Aeron.Context interServiceTimeout(long interServiceTimeout)
```
    Set the timeout between service calls the to ClientConductor duty cycles.
    
    Parameters:
    
    interServiceTimeout - the timeout (ms) between service calls the to ClientConductor duty cycles.
    
    Returns:
    
    this Aeron.Context for method chaining.
  - interServiceTimeout
```
public long interServiceTimeout()
```
    Return the timeout between service calls to the duty cycle 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.
  - imageMapMode
```
public java.nio.channels.FileChannel.MapMode imageMapMode()
```
    The file memory mapping mode for Images.
    
    Returns:
    
    the file memory mapping mode for Images.
  - 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

Class Aeron.Context

Field Summary

Fields inherited from class io.aeron.CommonContext

Constructor Summary

Method Summary

Methods inherited from class io.aeron.CommonContext

Methods inherited from class java.lang.Object

Constructor Detail

Context

Method Detail

conclude

epochClock

epochClock

nanoClock

nanoClock

idleStrategy

idleStrategy

toClientBuffer

toClientBuffer

toDriverBuffer

toDriverBuffer

driverProxy

driverProxy

logBuffersFactory

logBuffersFactory

errorHandler

errorHandler

availableImageHandler

availableImageHandler

unavailableImageHandler

unavailableImageHandler

keepAliveInterval

keepAliveInterval

driverTimeoutMs

interServiceTimeout

interServiceTimeout

aeronDirectoryName

publicationConnectionTimeout

publicationConnectionTimeout

imageMapMode

imageMapMode

threadFactory

threadFactory

close