io.aeron

Class Aeron.Configuration

java.lang.Object

io.aeron.Aeron.Configuration

Enclosing class:

Aeron

public static class Aeron.Configuration
extends Object

Configuration options for the Aeron client.

Field Summary

Fields

Modifier and Type	Field and Description
static long	CLOSE_LINGER_DURATION_DEFAULT_NS Default duration to linger on close so that publishers subscribers have time to notice closed resources.
static String	CLOSE_LINGER_DURATION_PROP_NAME Duration to linger on close so that publishers subscribers have time to notice closed resources.
static org.agrona.ErrorHandler	DEFAULT_ERROR_HANDLER The Default handler for Aeron runtime exceptions.
static boolean	PRE_TOUCH_MAPPED_MEMORY_DEFAULT Default for if a memory-mapped filed should be pre-touched to fault it into a process.
static String	PRE_TOUCH_MAPPED_MEMORY_PROP_NAME Should memory-mapped files be pre-touched so that they are already faulted into a process.
static long	RESOURCE_LINGER_DURATION_DEFAULT_NS Default duration a resource should linger before deletion.
static String	RESOURCE_LINGER_DURATION_PROP_NAME Duration to wait while lingering a entity such as an Image before deleting underlying resources such as memory mapped files.

Constructor Summary

Constructors

Constructor and Description
Configuration()

Method Summary

Modifier and Type	Method and Description
static long	closeLingerDurationNs() Duration to wait while lingering a entity such as an Image before deleting underlying resources such as memory mapped files.
static boolean	preTouchMappedMemory() Should memory-mapped files be pre-touched so that they are already faulted into a process.
static long	resourceLingerDurationNs() Duration to wait while lingering a entity such as an Image before deleting underlying resources such as memory mapped files.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_LINGER_DURATION_PROP_NAME

public static final String RESOURCE_LINGER_DURATION_PROP_NAME

Duration to wait while lingering a entity such as an Image before deleting underlying resources such as memory mapped files.

See Also:

Constant Field Values

RESOURCE_LINGER_DURATION_DEFAULT_NS

public static final long RESOURCE_LINGER_DURATION_DEFAULT_NS

Default duration a resource should linger before deletion.

CLOSE_LINGER_DURATION_PROP_NAME

public static final String CLOSE_LINGER_DURATION_PROP_NAME

Duration to linger on close so that publishers subscribers have time to notice closed resources. This value can be set to a few seconds if the application is likely to experience CPU starvation or long GC pauses.

See Also:

Constant Field Values

CLOSE_LINGER_DURATION_DEFAULT_NS

public static final long CLOSE_LINGER_DURATION_DEFAULT_NS

Default duration to linger on close so that publishers subscribers have time to notice closed resources.

See Also:

Constant Field Values

PRE_TOUCH_MAPPED_MEMORY_PROP_NAME

public static final String PRE_TOUCH_MAPPED_MEMORY_PROP_NAME

Should memory-mapped files be pre-touched so that they are already faulted into a process.

Pre-touching files can result in it taking it it taking longer for resources to become available in return for avoiding later pauses due to page faults.

See Also:

Constant Field Values

PRE_TOUCH_MAPPED_MEMORY_DEFAULT

public static final boolean PRE_TOUCH_MAPPED_MEMORY_DEFAULT

Default for if a memory-mapped filed should be pre-touched to fault it into a process.

See Also:

Constant Field Values

DEFAULT_ERROR_HANDLER

public static final org.agrona.ErrorHandler DEFAULT_ERROR_HANDLER

The Default handler for Aeron runtime exceptions. When a DriverTimeoutException is encountered, this handler will exit the program.

The error handler can be overridden by supplying an Aeron.Context with a custom handler.

See Also:

Aeron.Context.errorHandler(ErrorHandler)

Constructor Detail

Configuration

public Configuration()

Method Detail

resourceLingerDurationNs

public static long resourceLingerDurationNs()

Duration to wait while lingering a entity such as an Image before deleting underlying resources such as memory mapped files.

Returns:

duration in nanoseconds to wait before deleting a expired resource.

See Also:

RESOURCE_LINGER_DURATION_PROP_NAME

closeLingerDurationNs

public static long closeLingerDurationNs()

Duration to wait while lingering a entity such as an Image before deleting underlying resources such as memory mapped files.

Returns:

duration in nanoseconds to wait before deleting a expired resource.

See Also:

RESOURCE_LINGER_DURATION_PROP_NAME

preTouchMappedMemory

public static boolean preTouchMappedMemory()

Should memory-mapped files be pre-touched so that they are already faulted into a process.

Returns:

true if memory mappings should be pre-touched, otherwise false.

See Also:

PRE_TOUCH_MAPPED_MEMORY_PROP_NAME