A B C D E F G H I K L M N O P R S T U V W

A

abort() - Method in class io.aeron.logbuffer.BufferClaim

Abort a claim of the message space to the log buffer so that the log can progress by ignoring this claim.

abort() - Method in class io.aeron.logbuffer.ExclusiveBufferClaim

Abort a claim of the message space to the log buffer so that the log can progress by ignoring this claim.

activePartitionIndex(UnsafeBuffer) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Get the value of the active partition index used by the producer of this log.

activePartitionIndex(UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Set the value of the current active partition index for the producer.

activePartitionIndexOrdered(UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Set the value of the current active partition index for the producer using memory ordered semantics.

activeTermId() - Method in class io.aeron.protocol.SetupFlyweight

return active term id field

activeTermId(int) - Method in class io.aeron.protocol.SetupFlyweight

set active term id field

ADD_DESTINATION - Static variable in class io.aeron.command.ControlProtocolEvents

Add Destination to an existing Publication.

ADD_EXCLUSIVE_PUBLICATION - Static variable in class io.aeron.command.ControlProtocolEvents

Add an Exclusive Publication.

ADD_PUBLICATION - Static variable in class io.aeron.command.ControlProtocolEvents

Add a Publication.

ADD_SUBSCRIPTION - Static variable in class io.aeron.command.ControlProtocolEvents

Add a Subscriber.

addDestination(long, String) - Method in class io.aeron.DriverProxy

addDestination(String) - Method in class io.aeron.ExclusivePublication

Add a destination manually to a multi-destination-cast Publication.

addDestination(String) - Method in class io.aeron.Publication

Add a destination manually to a multi-destination-cast Publication.

addExclusivePublication(String, int) - Method in class io.aeron.Aeron

Add an ExclusivePublication for publishing messages to subscribers from a single thread.

addExclusivePublication(String, int) - Method in class io.aeron.DriverProxy

addPublication(String, int) - Method in class io.aeron.Aeron

Add a Publication for publishing messages to subscribers.

addPublication(String, int) - Method in class io.aeron.DriverProxy

addSubscription(String, int) - Method in class io.aeron.Aeron

Add a new Subscription for subscribing to messages from publishers.

addSubscription(String, int, AvailableImageHandler, UnavailableImageHandler) - Method in class io.aeron.Aeron

Add a new Subscription for subscribing to messages from publishers.

addSubscription(String, int) - Method in class io.aeron.DriverProxy

ADMIN_ACTION - Static variable in class io.aeron.ExclusivePublication

The offer failed due to an administration action and should be retried.

ADMIN_ACTION - Static variable in class io.aeron.Publication

The offer failed due to an administration action and should be retried.

Aeron - Class in io.aeron

Aeron entry point for communicating to the Media Driver for creating Publications and Subscriptions.

Aeron.Context - Class in io.aeron

This class provides configuration for the Aeron class via the Aeron.connect(Aeron.Context) method and its overloads.

AERON_DIR_PROP_DEFAULT - Static variable in class io.aeron.CommonContext

The value of the top level Aeron directory unless overridden by CommonContext.aeronDirectoryName(String)

AERON_DIR_PROP_NAME - Static variable in class io.aeron.CommonContext

The top level Aeron directory used for communication between a Media Driver and client.

aeronDirectory() - Method in class io.aeron.CommonContext

Get the directory in which the aeron config files are stored.

aeronDirectoryName(String) - Method in class io.aeron.Aeron.Context

aeronDirectoryName() - Method in class io.aeron.CommonContext

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

aeronDirectoryName(String) - Method in class io.aeron.CommonContext

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

append(DirectBuffer, int, int) - Method in class io.aeron.BufferBuilder

Append a source buffer to the end of the internal buffer, resizing the internal buffer as required.

appendFragmentedMessage(int, int, HeaderWriter, DirectBuffer, int, int, int, ReservedValueSupplier) - Method in class io.aeron.logbuffer.ExclusiveTermAppender

Append a fragmented message to the the term buffer.

appendFragmentedMessage(HeaderWriter, DirectBuffer, int, int, int, ReservedValueSupplier) - Method in class io.aeron.logbuffer.TermAppender

Append a fragmented message to the the term buffer.

appendUnfragmentedMessage(int, int, HeaderWriter, DirectBuffer, int, int, ReservedValueSupplier) - Method in class io.aeron.logbuffer.ExclusiveTermAppender

Append an unfragmented message to the the term buffer.

appendUnfragmentedMessage(HeaderWriter, DirectBuffer, int, int, ReservedValueSupplier) - Method in class io.aeron.logbuffer.TermAppender

Append an unfragmented message to the the term buffer.

applicationSpecificFeedback(byte[]) - Method in class io.aeron.protocol.StatusMessageFlyweight

Retrieve the Application Specific Feedback (if present) from the Status Message.

applicationSpecificFeedback(byte[], int, int) - Method in class io.aeron.protocol.StatusMessageFlyweight

Set the Application Specific Feedback for the Status Message.

applyDefaultHeader(UnsafeBuffer, UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Apply the default header for a message in a term.

available(long) - Static method in class io.aeron.logbuffer.TermScanner

The number of bytes that are available to be read after a scan.

availableImageHandler(AvailableImageHandler) - Method in class io.aeron.Aeron.Context

Setup a default callback for when an Image is available.

availableImageHandler() - Method in class io.aeron.Aeron.Context

Get the default callback handler for notifying when Images become available.

AvailableImageHandler - Interface in io.aeron

Interface for notification of new Images becoming available under a Subscription.

availableImageHandler() - Method in class io.aeron.Subscription

Callback used to indicate when an Image becomes available under this Subscription.

B

BACK_PRESSURED - Static variable in class io.aeron.ExclusivePublication

The offer failed due to back pressure from the subscribers preventing further transmission.

BACK_PRESSURED - Static variable in class io.aeron.Publication

The offer failed due to back pressure from the subscribers preventing further transmission.

BEGIN_AND_END_FLAGS - Static variable in class io.aeron.protocol.DataHeaderFlyweight

Begin and End Flags

BEGIN_FLAG - Static variable in class io.aeron.protocol.DataHeaderFlyweight

Begin Flag

BEGIN_FRAG_FLAG - Static variable in class io.aeron.logbuffer.FrameDescriptor

Beginning fragment of a frame.

BlockHandler - Interface in io.aeron.logbuffer

Function for handling a block of message fragments scanned from the log.

blockPoll(BlockHandler, int) - Method in class io.aeron.Image

Poll for new messages in a stream.

blockPoll(BlockHandler, int) - Method in class io.aeron.Subscription

Poll the Images under the subscription for available message fragments in blocks.

buffer() - Method in class io.aeron.BufferBuilder

The MutableDirectBuffer that encapsulates the internal buffer.

buffer - Variable in class io.aeron.command.CorrelatedMessageFlyweight

buffer() - Method in class io.aeron.logbuffer.BufferClaim

The referenced buffer to be used.

buffer() - Method in class io.aeron.logbuffer.ExclusiveBufferClaim

The referenced buffer to be used.

buffer() - Method in class io.aeron.logbuffer.Header

The DirectBuffer containing the header.

buffer(DirectBuffer) - Method in class io.aeron.logbuffer.Header

The DirectBuffer containing the header.

BufferBuilder - Class in io.aeron

Reusable Builder for appending a sequence of buffers that grows internal capacity as needed.

BufferBuilder() - Constructor for class io.aeron.BufferBuilder

Construct a buffer builder with a default growth increment of BufferBuilder.INITIAL_CAPACITY

BufferBuilder(int) - Constructor for class io.aeron.BufferBuilder

Construct a buffer builder with an initial capacity that will be rounded up to the nearest power of 2.

BufferClaim - Class in io.aeron.logbuffer

Represents a claimed range in a buffer to be used for recording a message without copy semantics for later commit.

BufferClaim() - Constructor for class io.aeron.logbuffer.BufferClaim

C

capacity() - Method in class io.aeron.BufferBuilder

The current capacity of the buffer.

channel() - Method in class io.aeron.command.DestinationMessageFlyweight

Get the channel field in ASCII

channel(String) - Method in class io.aeron.command.DestinationMessageFlyweight

Set channel field in ASCII

channel() - Method in class io.aeron.command.ImageMessageFlyweight

Get the channel field as ASCII

channel(String) - Method in class io.aeron.command.ImageMessageFlyweight

Set the channel field as ASCII

channel() - Method in class io.aeron.command.PublicationMessageFlyweight

Get the channel field in ASCII

channel(String) - Method in class io.aeron.command.PublicationMessageFlyweight

Set the channel field in ASCII

channel() - Method in class io.aeron.command.SubscriptionMessageFlyweight

Get the channel field in ASCII

channel(String) - Method in class io.aeron.command.SubscriptionMessageFlyweight

Set channel field in ASCII

channel() - Method in class io.aeron.ExclusivePublication

Media address for delivery to the channel.

channel() - Method in class io.aeron.Publication

Media address for delivery to the channel.

channel() - Method in class io.aeron.Subscription

Media address for delivery to the channel.

checkTermLength(int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Check that term length is valid and alignment is valid.

claim(int, int, HeaderWriter, int, ExclusiveBufferClaim) - Method in class io.aeron.logbuffer.ExclusiveTermAppender

Claim length of a the term buffer for writing in the message with zero copy semantics.

claim(HeaderWriter, int, BufferClaim) - Method in class io.aeron.logbuffer.TermAppender

Claim length of a the term buffer for writing in the message with zero copy semantics.

clear() - Method in class io.aeron.ControlledFragmentAssembler

Clear down the cache of buffers by session for reassembling messages.

clear() - Method in class io.aeron.FragmentAssembler

Clear down the cache of buffers by session for reassembling messages.

CLIENT_ID_FIELD_OFFSET - Static variable in class io.aeron.command.CorrelatedMessageFlyweight

CLIENT_KEEPALIVE - Static variable in class io.aeron.command.ControlProtocolEvents

Keepalive from Client.

CLIENT_LIVENESS_TIMEOUT_FIELD_OFFSET - Static variable in class io.aeron.CncFileDescriptor

clientId() - Method in class io.aeron.command.CorrelatedMessageFlyweight

return client id field

clientId(long) - Method in class io.aeron.command.CorrelatedMessageFlyweight

set client id field

clientLivenessTimeout(DirectBuffer) - Static method in class io.aeron.CncFileDescriptor

clientLivenessTimeoutOffset(int) - Static method in class io.aeron.CncFileDescriptor

close() - Method in class io.aeron.Aeron

Clean up and release all Aeron internal resources and shutdown threads.

close() - Method in class io.aeron.Aeron.Context

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

close() - Method in class io.aeron.CommonContext

Release resources used by the CommonContext.

close() - Method in class io.aeron.ExclusivePublication

Release resources used by this Publication.

close() - Method in class io.aeron.LogBuffers

close() - Method in class io.aeron.Publication

Release resources used by this Publication when there are no more references.

close() - Method in class io.aeron.Subscription

Close the Subscription so that associated Images can be released.

CLOSED - Static variable in class io.aeron.ExclusivePublication

The ExclusivePublication has been closed and should no longer be used.

CLOSED - Static variable in class io.aeron.Publication

The Publication has been closed and should no longer be used.

CNC_FILE - Static variable in class io.aeron.CncFileDescriptor

CNC_METADATA_OFFSET - Static variable in class io.aeron.CncFileDescriptor

CNC_VERSION - Static variable in class io.aeron.CncFileDescriptor

CNC_VERSION_FIELD_OFFSET - Static variable in class io.aeron.CncFileDescriptor

cncFile() - Method in class io.aeron.CommonContext

Get the command and control file.

CncFileDescriptor - Class in io.aeron

Description of the command and control file used between driver and clients File Layout

CncFileDescriptor() - Constructor for class io.aeron.CncFileDescriptor

cncVersionOffset(int) - Static method in class io.aeron.CncFileDescriptor

commit() - Method in class io.aeron.logbuffer.BufferClaim

Commit the message to the log buffer so that is it available to subscribers.

commit() - Method in class io.aeron.logbuffer.ExclusiveBufferClaim

Commit the message to the log buffer so that is it available to subscribers.

CommonContext - Class in io.aeron

This class provides the Media Driver and client with common configuration for the Aeron directory.

CommonContext() - Constructor for class io.aeron.CommonContext

Create a new context with Aeron directory and delete on exit values based on the current system properties.

compact() - Method in class io.aeron.BufferBuilder

Compact the buffer to reclaim unused space above the limit.

computeCncFileLength(int) - Static method in class io.aeron.CncFileDescriptor

Compute the length of the cnc file and return it.

computeExclusiveMaxMessageLength(int) - Static method in class io.aeron.logbuffer.FrameDescriptor

Compute the maximum supported message length for a buffer of given capacity when the publication is exclusive.

computeLogLength(int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Compute the total length of a log file given the term length.

computeMaxMessageLength(int) - Static method in class io.aeron.logbuffer.FrameDescriptor

Compute the maximum supported message length for a buffer of given capacity.

computePosition(int, int, int, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Compute the current position in absolute number of bytes.

computeTermBeginPosition(int, int, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Compute the current position in absolute number of bytes for the beginning of a term.

computeTermIdFromPosition(long, int, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Compute the term id from a position.

computeTermLength(long) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Compute the term length based on the total length of the log.

computeTermOffsetFromPosition(long, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Compute the term offset from a given position.

conclude() - Method in class io.aeron.Aeron.Context

This is called automatically by Aeron.connect(Aeron.Context) and its overloads.

conclude() - Method in class io.aeron.CommonContext

This completes initialization of the CommonContext object.

concludeAeronDirectory() - Method in class io.aeron.CommonContext

Conclude the CommonContext.aeronDirectory() so it does not need to keep being recreated.

ConductorServiceTimeoutException - Exception in io.aeron.exceptions

A timeout has occurred between service calls for the client conductor.

ConductorServiceTimeoutException(String) - Constructor for exception io.aeron.exceptions.ConductorServiceTimeoutException

connect() - Static method in class io.aeron.Aeron

Create an Aeron instance and connect to the media driver with a default Aeron.Context.

connect(Aeron.Context) - Static method in class io.aeron.Aeron

Create an Aeron instance and connect to the media driver.

consumptionTermId() - Method in class io.aeron.protocol.StatusMessageFlyweight

return highest consumption term id field

consumptionTermId(int) - Method in class io.aeron.protocol.StatusMessageFlyweight

set highest consumption term id field

consumptionTermOffset() - Method in class io.aeron.protocol.StatusMessageFlyweight

return highest consumption term offset field

consumptionTermOffset(int) - Method in class io.aeron.protocol.StatusMessageFlyweight

set highest consumption term offset field

Context() - Constructor for class io.aeron.Aeron.Context

ControlledFragmentAssembler - Class in io.aeron

A ControlledFragmentHandler that sits in a chain-of-responsibility pattern that reassembles fragmented messages so that the next handler in the chain only sees whole messages.

ControlledFragmentAssembler(ControlledFragmentHandler) - Constructor for class io.aeron.ControlledFragmentAssembler

Construct an adapter to reassemble message fragments and delegate on whole messages.

ControlledFragmentAssembler(ControlledFragmentHandler, int) - Constructor for class io.aeron.ControlledFragmentAssembler

Construct an adapter to reassemble message fragments and delegate on whole messages.

ControlledFragmentHandler - Interface in io.aeron.logbuffer

Handler for reading data that is coming from a log buffer.

ControlledFragmentHandler.Action - Enum in io.aeron.logbuffer

controlledPeek(long, ControlledFragmentHandler, long) - Method in class io.aeron.Image

Peek for new messages in a stream by scanning forward from an initial position.

controlledPoll(ControlledFragmentHandler, int) - Method in class io.aeron.Image

Poll for new messages in a stream.

controlledPoll(ControlledFragmentHandler, int) - Method in class io.aeron.Subscription

Poll in a controlled manner the Images under the subscription for available message fragments.

ControlProtocolEvents - Class in io.aeron.command

List of events used in the control protocol between client and the media driver.

ControlProtocolEvents() - Constructor for class io.aeron.command.ControlProtocolEvents

CorrelatedMessageFlyweight - Class in io.aeron.command

0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Client ID | | | +---------------------------------------------------------------+ | Correlation ID | | | +---------------------------------------------------------------+

CorrelatedMessageFlyweight() - Constructor for class io.aeron.command.CorrelatedMessageFlyweight

CORRELATION_ID_FIELD_OFFSET - Static variable in class io.aeron.command.CorrelatedMessageFlyweight

correlationId() - Method in class io.aeron.command.CorrelatedMessageFlyweight

return correlation id field

correlationId(long) - Method in class io.aeron.command.CorrelatedMessageFlyweight

set correlation id field

correlationId() - Method in class io.aeron.command.ImageBuffersReadyFlyweight

return correlation id field

correlationId(long) - Method in class io.aeron.command.ImageBuffersReadyFlyweight

set correlation id field

correlationId() - Method in class io.aeron.command.ImageMessageFlyweight

return correlation id field

correlationId(long) - Method in class io.aeron.command.ImageMessageFlyweight

set correlation id field

correlationId() - Method in class io.aeron.command.PublicationBuffersReadyFlyweight

return correlation id field

correlationId(long) - Method in class io.aeron.command.PublicationBuffersReadyFlyweight

set correlation id field

correlationId() - Method in class io.aeron.Image

The correlationId for identification of the image with the media driver.

correlationId(UnsafeBuffer) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Get the value of the correlation ID for this log relating to the command which created it.

correlationId(UnsafeBuffer, long) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Set the correlation ID used for this log relating to the command which created it.

COUNTERS_METADATA_BUFFER_LENGTH_FIELD_OFFSET - Static variable in class io.aeron.CncFileDescriptor

COUNTERS_VALUES_BUFFER_LENGTH_FIELD_OFFSET - Static variable in class io.aeron.CncFileDescriptor

countersMetaDataBuffer() - Method in class io.aeron.CommonContext

Get the buffer containing the counter meta data.

countersMetaDataBuffer(UnsafeBuffer) - Method in class io.aeron.CommonContext

Set the buffer containing the counter meta data.

countersMetaDataBufferLengthOffset(int) - Static method in class io.aeron.CncFileDescriptor

countersReader() - Method in class io.aeron.Aeron

Create and return a CountersReader for the Aeron media driver counters.

countersValuesBuffer() - Method in class io.aeron.CommonContext

Get the buffer containing the counters.

countersValuesBuffer(UnsafeBuffer) - Method in class io.aeron.CommonContext

Set the buffer containing the counters

countersValuesBufferLengthOffset(int) - Static method in class io.aeron.CncFileDescriptor

createCountersMetaDataBuffer(ByteBuffer, DirectBuffer) - Static method in class io.aeron.CncFileDescriptor

createCountersValuesBuffer(ByteBuffer, DirectBuffer) - Static method in class io.aeron.CncFileDescriptor

createDefaultHeader(int, int, int) - Static method in class io.aeron.protocol.DataHeaderFlyweight

Return an initialised default Data Frame Header.

createErrorLogBuffer(ByteBuffer, DirectBuffer) - Static method in class io.aeron.CncFileDescriptor

createMetaDataBuffer(ByteBuffer) - Static method in class io.aeron.CncFileDescriptor

createToClientsBuffer(ByteBuffer, DirectBuffer) - Static method in class io.aeron.CncFileDescriptor

createToDriverBuffer(ByteBuffer, DirectBuffer) - Static method in class io.aeron.CncFileDescriptor

CURRENT_VERSION - Static variable in class io.aeron.protocol.HeaderFlyweight

default version

D

DATA_OFFSET - Static variable in class io.aeron.protocol.DataHeaderFlyweight

DataHeaderFlyweight - Class in io.aeron.protocol

HeaderFlyweight for Data Header Data Frame

DataHeaderFlyweight() - Constructor for class io.aeron.protocol.DataHeaderFlyweight

DataHeaderFlyweight(UnsafeBuffer) - Constructor for class io.aeron.protocol.DataHeaderFlyweight

DataHeaderFlyweight(ByteBuffer) - Constructor for class io.aeron.protocol.DataHeaderFlyweight

dataOffset() - Method in class io.aeron.protocol.DataHeaderFlyweight

Return offset in buffer for data

DEFAULT_DRIVER_TIMEOUT_MS - Static variable in class io.aeron.CommonContext

Timeout in which the driver is expected to respond.

DEFAULT_ERROR_HANDLER - Static variable in class io.aeron.Aeron

The Default handler for Aeron runtime exceptions.

DEFAULT_RESERVE_VALUE - Static variable in class io.aeron.protocol.DataHeaderFlyweight

defaultFrameHeader(UnsafeBuffer) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Get a wrapper around the default frame header from the log meta data.

delegate() - Method in class io.aeron.ControlledFragmentAssembler

Get the delegate unto which assembled messages are delegated.

delegate() - Method in class io.aeron.FragmentAssembler

Get the delegate unto which assembled messages are delegated.

delegate() - Method in class io.aeron.ImageControlledFragmentAssembler

Get the delegate unto which assembled messages are delegated.

delegate() - Method in class io.aeron.ImageFragmentAssembler

Get the delegate unto which assembled messages are delegated.

deleteAeronDirectory() - Method in class io.aeron.CommonContext

Delete the current Aeron directory, throwing errors if not possible.

DestinationMessageFlyweight - Class in io.aeron.command

DestinationMessageFlyweight() - Constructor for class io.aeron.command.DestinationMessageFlyweight

driverProxy(DriverProxy) - Method in class io.aeron.Aeron.Context

Set the proxy for communicating with the media driver.

driverProxy() - Method in class io.aeron.Aeron.Context

Get the proxy for communicating with the media driver.

DriverProxy - Class in io.aeron

Separates the concern of communicating with the client conductor away from the rest of the client.

DriverProxy(RingBuffer) - Constructor for class io.aeron.DriverProxy

DriverTimeoutException - Exception in io.aeron.exceptions

A timeout has occurred while waiting on the media driver responding to an operation.

DriverTimeoutException(String) - Constructor for exception io.aeron.exceptions.DriverTimeoutException

driverTimeoutMs(long) - Method in class io.aeron.Aeron.Context

Set the amount of time, in milliseconds, that this client will wait until it determines the Media Driver is unavailable.

driverTimeoutMs(long) - Method in class io.aeron.CommonContext

Set the driver timeout in milliseconds

driverTimeoutMs() - Method in class io.aeron.CommonContext

Get the driver timeout in milliseconds.

E

echoTimestamp() - Method in class io.aeron.protocol.RttMeasurementFlyweight

echoTimestamp(long) - Method in class io.aeron.protocol.RttMeasurementFlyweight

EMPTY_BUFFER - Static variable in class io.aeron.protocol.HeaderFlyweight

END_FLAG - Static variable in class io.aeron.protocol.DataHeaderFlyweight

End Flag

END_FRAG_FLAG - Static variable in class io.aeron.logbuffer.FrameDescriptor

End fragment of a frame.

END_OF_METADATA_OFFSET - Static variable in class io.aeron.CncFileDescriptor

epochClock(EpochClock) - Method in class io.aeron.Aeron.Context

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

epochClock() - Method in class io.aeron.Aeron.Context

Get the Clock used by the client for the epoch time in milliseconds.

ERROR_LOG_BUFFER_LENGTH_FIELD_OFFSET - Static variable in class io.aeron.CncFileDescriptor

errorCode() - Method in class io.aeron.command.ErrorResponseFlyweight

Error code for the command.

errorCode(ErrorCode) - Method in class io.aeron.command.ErrorResponseFlyweight

Set the error code for the command.

ErrorCode - Enum in io.aeron

Error codes between media driver and client and the on-wire protocol.

errorCode() - Method in exception io.aeron.exceptions.RegistrationException

Get the ErrorCode for the specific exception.

errorHandler(ErrorHandler) - Method in class io.aeron.Aeron.Context

Handle Aeron exceptions in a callback method.

errorHandler() - Method in class io.aeron.Aeron.Context

Get the error handler that will be called for errors reported back from the media driver.

errorLogBufferLengthOffset(int) - Static method in class io.aeron.CncFileDescriptor

errorMessage() - Method in class io.aeron.command.ErrorResponseFlyweight

Error message associated with the error.

errorMessage(String) - Method in class io.aeron.command.ErrorResponseFlyweight

Set the error message

ErrorResponseFlyweight - Class in io.aeron.command

Control message flyweight for any errors sent from driver to clients 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Offending Command Correlation ID | | | +---------------------------------------------------------------+ | Error Code | +---------------------------------------------------------------+ | Error Message Length | +---------------------------------------------------------------+ | Error Message ...

ErrorResponseFlyweight() - Constructor for class io.aeron.command.ErrorResponseFlyweight

ExclusiveBufferClaim - Class in io.aeron.logbuffer

Represents a claimed range in a buffer to be used for recording a message without copy semantics for later commit.

ExclusiveBufferClaim() - Constructor for class io.aeron.logbuffer.ExclusiveBufferClaim

ExclusivePublication - Class in io.aeron

Aeron Publisher API for sending messages to subscribers of a given channel and streamId pair.

ExclusiveTermAppender - Class in io.aeron.logbuffer

Term buffer appender which supports a single exclusive producer writing an append-only log.

ExclusiveTermAppender(UnsafeBuffer, UnsafeBuffer, int) - Constructor for class io.aeron.logbuffer.ExclusiveTermAppender

Construct a view over a term buffer and state buffer for appending frames.

F

FAILED - Static variable in class io.aeron.logbuffer.ExclusiveTermAppender

The append operation went past the end of the buffer and failed.

FAILED - Static variable in class io.aeron.logbuffer.TermAppender

The append operation went past the end of the buffer and failed.

fileChannel() - Method in class io.aeron.Image

The FileChannel to the raw log of the Image.

fileChannel() - Method in class io.aeron.LogBuffers

fillMetaData(UnsafeBuffer, int, int, int, int, long, int) - Static method in class io.aeron.CncFileDescriptor

flags() - Method in class io.aeron.logbuffer.ExclusiveBufferClaim

Get the value of the flags field.

flags(byte) - Method in class io.aeron.logbuffer.ExclusiveBufferClaim

Set the value of the header flags field.

flags() - Method in class io.aeron.logbuffer.Header

The flags for this frame.

flags() - Method in class io.aeron.protocol.HeaderFlyweight

return flags field value

flags(short) - Method in class io.aeron.protocol.HeaderFlyweight

set the flags field value

FLAGS_FIELD_OFFSET - Static variable in class io.aeron.protocol.HeaderFlyweight

FLAGS_OFFSET - Static variable in class io.aeron.logbuffer.FrameDescriptor

Offset within a frame at which the flags field begins

flagsOffset(int) - Static method in class io.aeron.logbuffer.FrameDescriptor

The buffer offset at which the flags field begins.

forEachImage(Consumer<Image>) - Method in class io.aeron.Subscription

Iterate over the Images for this subscription.

FragmentAssembler - Class in io.aeron

A FragmentHandler that sits in a chain-of-responsibility pattern that reassembles fragmented messages so that the next handler in the chain only sees whole messages.

FragmentAssembler(FragmentHandler) - Constructor for class io.aeron.FragmentAssembler

Construct an adapter to reassemble message fragments and delegate on whole messages.

FragmentAssembler(FragmentHandler, int) - Constructor for class io.aeron.FragmentAssembler

Construct an adapter to reassemble message fragments and delegate on whole messages.

FragmentHandler - Interface in io.aeron.logbuffer

Handler for reading data that is coming from a log buffer.

fragmentsRead(long) - Static method in class io.aeron.logbuffer.TermReader

The number of fragments that have been read.

FRAME_ALIGNMENT - Static variable in class io.aeron.logbuffer.FrameDescriptor

Alignment as a multiple of bytes for each frame.

FRAME_LENGTH_FIELD_OFFSET - Static variable in class io.aeron.protocol.HeaderFlyweight

FrameDescriptor - Class in io.aeron.logbuffer

Description of the structure for message framing in a log buffer.

FrameDescriptor() - Constructor for class io.aeron.logbuffer.FrameDescriptor

frameFlags(UnsafeBuffer, int, byte) - Static method in class io.aeron.logbuffer.FrameDescriptor

Write the flags field for a frame.

frameLength(UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.FrameDescriptor

Get the length of a frame from the header.

frameLength() - Method in class io.aeron.logbuffer.Header

The total length of the frame including the header.

frameLength() - Method in class io.aeron.protocol.HeaderFlyweight

return frame length field

frameLength(int) - Method in class io.aeron.protocol.HeaderFlyweight

set frame length field

frameLengthOrdered(UnsafeBuffer, int, int) - Static method in class io.aeron.logbuffer.FrameDescriptor

Write the length header for a frame in a memory ordered fashion.

frameLengthVolatile(UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.FrameDescriptor

Get the length of a frame from the header as a volatile read.

frameTermId(UnsafeBuffer, int, int) - Static method in class io.aeron.logbuffer.FrameDescriptor

Write the term id field for a frame.

frameTermOffset(UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.FrameDescriptor

Write the term offset field for a frame.

frameType(UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.FrameDescriptor

Read the type of of the frame from header.

frameType(UnsafeBuffer, int, int) - Static method in class io.aeron.logbuffer.FrameDescriptor

Write the type field for a frame.

frameVersion(UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.FrameDescriptor

Read the type of of the frame from header.

freeSessionBuffer(int) - Method in class io.aeron.ControlledFragmentAssembler

Free an existing session buffer to reduce memory pressure when an image goes inactive or no more large messages are expected.

freeSessionBuffer(int) - Method in class io.aeron.FragmentAssembler

Free an existing session buffer to reduce memory pressure when an image goes inactive or no more large messages are expected.

G

generateRandomDirName() - Static method in class io.aeron.CommonContext

Convert the default Aeron directory name to be a random name for use with embedded drivers.

get(int) - Static method in enum io.aeron.ErrorCode

Get the ErrorCode that corresponds to the given value.

get(DirectBuffer, int, int) - Method in interface io.aeron.ReservedValueSupplier

getImage(int) - Method in class io.aeron.Subscription

Get the image at the given index from the images array.

H

hasNoImages() - Method in class io.aeron.Subscription

Has the subscription currently no images connected to it?

HDR_TYPE_DATA - Static variable in class io.aeron.protocol.HeaderFlyweight

header type DATA

HDR_TYPE_ERR - Static variable in class io.aeron.protocol.HeaderFlyweight

header type ERR

HDR_TYPE_EXT - Static variable in class io.aeron.protocol.HeaderFlyweight

header type EXT

HDR_TYPE_NAK - Static variable in class io.aeron.protocol.HeaderFlyweight

header type NAK

HDR_TYPE_PAD - Static variable in class io.aeron.protocol.HeaderFlyweight

header type PAD

HDR_TYPE_RTTM - Static variable in class io.aeron.protocol.HeaderFlyweight

header type RTT Measurement

HDR_TYPE_SETUP - Static variable in class io.aeron.protocol.HeaderFlyweight

header type SETUP

HDR_TYPE_SM - Static variable in class io.aeron.protocol.HeaderFlyweight

header type SM

Header - Class in io.aeron.logbuffer

Represents the header of the data frame for accessing meta data fields.

Header(int, int) - Constructor for class io.aeron.logbuffer.Header

Construct a header that references a buffer for the log.

HEADER_LENGTH - Static variable in class io.aeron.protocol.DataHeaderFlyweight

Length of the Data Header

HEADER_LENGTH - Static variable in class io.aeron.protocol.HeaderFlyweight

HEADER_LENGTH - Static variable in class io.aeron.protocol.NakFlyweight

HEADER_LENGTH - Static variable in class io.aeron.protocol.RttMeasurementFlyweight

HEADER_LENGTH - Static variable in class io.aeron.protocol.SetupFlyweight

Size of the Setup Header

HEADER_LENGTH - Static variable in class io.aeron.protocol.StatusMessageFlyweight

Length of the Status Message Packet

HeaderFlyweight - Class in io.aeron.protocol

Flyweight for general Aeron network protocol header 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Frame Length | +---------------------------------------------------------------+ | Version | Flags | Type | +-------------+---------------+---------------------------------+ | Depends on Type ...

HeaderFlyweight() - Constructor for class io.aeron.protocol.HeaderFlyweight

HeaderFlyweight(UnsafeBuffer) - Constructor for class io.aeron.protocol.HeaderFlyweight

HeaderFlyweight(ByteBuffer) - Constructor for class io.aeron.protocol.HeaderFlyweight

headerType() - Method in class io.aeron.logbuffer.ExclusiveBufferClaim

Get the value of the header type field.

headerType(int) - Method in class io.aeron.logbuffer.ExclusiveBufferClaim

Set the value of the header type field.

headerType() - Method in class io.aeron.protocol.HeaderFlyweight

return header type field

headerType(int) - Method in class io.aeron.protocol.HeaderFlyweight

set header type field

HeaderWriter - Class in io.aeron.logbuffer

Utility for applying a header to a message in a term buffer.

HeaderWriter(UnsafeBuffer) - Constructor for class io.aeron.logbuffer.HeaderWriter

I

IDLE_SLEEP_NS - Static variable in class io.aeron.Aeron

Duration in nanoseconds for which the client conductor will sleep between duty cycles.

idleStrategy(IdleStrategy) - Method in class io.aeron.Aeron.Context

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

idleStrategy() - Method in class io.aeron.Aeron.Context

Get the IdleStrategy employed by the client conductor thread.

Image - Class in io.aeron

Represents a replicated publication Image from a publisher to a Subscription.

Image(Subscription, int, Position, LogBuffers, ErrorHandler, String, long) - Constructor for class io.aeron.Image

Construct a new image over a log to represent a stream of messages from a Publication.

ImageBuffersReadyFlyweight - Class in io.aeron.command

Message to denote that new buffers have been added for a subscription.

ImageBuffersReadyFlyweight() - Constructor for class io.aeron.command.ImageBuffersReadyFlyweight

imageBySessionId(int) - Method in class io.aeron.Subscription

Return the Image associated with the given sessionId.

ImageControlledFragmentAssembler - Class in io.aeron

A ControlledFragmentHandler that sits in a chain-of-responsibility pattern that reassembles fragmented messages so that the next handler in the chain only sees whole messages.

ImageControlledFragmentAssembler(ControlledFragmentHandler) - Constructor for class io.aeron.ImageControlledFragmentAssembler

Construct an adapter to reassemble message fragments and delegate on whole messages.

ImageControlledFragmentAssembler(ControlledFragmentHandler, int) - Constructor for class io.aeron.ImageControlledFragmentAssembler

Construct an adapter to reassemble message fragments and delegate on whole messages.

imageCount() - Method in class io.aeron.Subscription

Count of images connected to this subscription.

ImageFragmentAssembler - Class in io.aeron

A FragmentHandler that sits in a chain-of-responsibility pattern that reassembles fragmented messages so that the next handler in the chain only sees whole messages.

ImageFragmentAssembler(FragmentHandler) - Constructor for class io.aeron.ImageFragmentAssembler

Construct an adapter to reassemble message fragments and delegate on only whole messages.

ImageFragmentAssembler(FragmentHandler, int) - Constructor for class io.aeron.ImageFragmentAssembler

Construct an adapter to reassemble message fragments and delegate on only whole messages.

imageMapMode(FileChannel.MapMode) - Method in class io.aeron.Aeron.Context

The file memory mapping mode for Images.

imageMapMode() - Method in class io.aeron.Aeron.Context

The file memory mapping mode for Images.

ImageMessageFlyweight - Class in io.aeron.command

Control message flyweight for any message that needs to represent a connection 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Correlation ID | | | +---------------------------------------------------------------+ | Stream ID | +---------------------------------------------------------------+ | Channel Length | +---------------------------------------------------------------+ | Channel (ASCII) ...

ImageMessageFlyweight() - Constructor for class io.aeron.command.ImageMessageFlyweight

images() - Method in class io.aeron.Subscription

Get a List of active Images that match this subscription.

indexByPosition(long, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Determine the partition index given a stream position.

indexByTerm(int, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Determine the partition index to be used given the initial term and active term ids.

indexByTermCount(long) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Determine the partition index based on number of terms that have passed.

INITIAL_CAPACITY - Static variable in class io.aeron.BufferBuilder

Initial capacity for the internal buffer.

INITIAL_TERM_ID_PARAM_NAME - Static variable in class io.aeron.CommonContext

Initial term id to be used when creating an ExclusivePublication.

initialiseTailWithTermId(UnsafeBuffer, int, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Set the initial value for the termId in the upper bits of the tail counter.

initialTermId() - Method in class io.aeron.ExclusivePublication

The initial term id assigned when this ExclusivePublication was created.

initialTermId() - Method in class io.aeron.Image

The initial term at which the stream started for this session.

initialTermId() - Method in class io.aeron.logbuffer.Header

Get the initial term id this stream started at.

initialTermId(UnsafeBuffer) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Get the value of the initial Term id used for this log.

initialTermId(UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Set the initial term at which this log begins.

initialTermId() - Method in class io.aeron.protocol.SetupFlyweight

return initial term id field

initialTermId(int) - Method in class io.aeron.protocol.SetupFlyweight

set initial term id field

initialTermId() - Method in class io.aeron.Publication

The initial term id assigned when this Publication was created.

insert(UnsafeBuffer, int, UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.TermRebuilder

Insert a packet of frames into the log at the appropriate termOffset as indicated by the term termOffset header.

INTER_SERVICE_TIMEOUT_NS - Static variable in class io.aeron.Aeron

Default interval that if exceeded between duty cycles the conductor will consider itself a zombie and suicide.

interServiceTimeout(long) - Method in class io.aeron.Aeron.Context

Set the timeout between service calls the to ClientConductor duty cycles.

interServiceTimeout() - Method in class io.aeron.Aeron.Context

Return the timeout between service calls to the duty cycle for the client.

io.aeron - package io.aeron

io.aeron.command - package io.aeron.command

io.aeron.exceptions - package io.aeron.exceptions

io.aeron.logbuffer - package io.aeron.logbuffer

io.aeron.protocol - package io.aeron.protocol

IPC_CHANNEL - Static variable in class io.aeron.CommonContext

URI used for IPC Publications and Subscriptions

isClosed() - Method in class io.aeron.ExclusivePublication

Has this object been closed and should no longer be used?

isClosed() - Method in class io.aeron.Image

Has this object been closed and should no longer be used?

isClosed() - Method in class io.aeron.Publication

Has this object been closed and should no longer be used?

isClosed() - Method in class io.aeron.Subscription

Has this object been closed and should no longer be used?

isConnected() - Method in class io.aeron.ExclusivePublication

Has the ExclusivePublication seen an active Subscriber recently?

isConnected() - Method in class io.aeron.Publication

Has the Publication seen an active Subscriber recently?

isDriverActive(File, long, Consumer<String>) - Static method in class io.aeron.CommonContext

Is a media driver active in the given directory?

isDriverActive(long, Consumer<String>) - Method in class io.aeron.CommonContext

Is a media driver active in the current Aeron directory?

isDriverActive(long, Consumer<String>, MappedByteBuffer) - Static method in class io.aeron.CommonContext

Is a media driver active in the current mapped CnC buffer?

isPaddingFrame(UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.FrameDescriptor

Is the frame starting at the termOffset a padding frame at the end of a buffer?

K

KEEPALIVE_INTERVAL_NS - Static variable in class io.aeron.Aeron

Default interval between sending keepalive control messages to the driver.

keepAliveInterval(long) - Method in class io.aeron.Aeron.Context

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

keepAliveInterval() - Method in class io.aeron.Aeron.Context

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

L

LENGTH - Static variable in class io.aeron.command.CorrelatedMessageFlyweight

length() - Method in class io.aeron.command.DestinationMessageFlyweight

length() - Method in class io.aeron.command.ErrorResponseFlyweight

Length of the error response in bytes.

length() - Method in class io.aeron.command.ImageBuffersReadyFlyweight

Get the length of the current message NB: must be called after the data is written in order to be accurate.

length() - Method in class io.aeron.command.ImageMessageFlyweight

Get the length of the current message NB: must be called after the data is written in order to be accurate.

length() - Method in class io.aeron.command.PublicationBuffersReadyFlyweight

Get the length of the current message NB: must be called after the data is written in order to be accurate.

length() - Method in class io.aeron.command.PublicationMessageFlyweight

Get the length of the current message NB: must be called after the data is written in order to be accurate.

length() - Static method in class io.aeron.command.RemoveMessageFlyweight

length() - Method in class io.aeron.command.SubscriptionMessageFlyweight

length() - Method in class io.aeron.logbuffer.BufferClaim

The length of the claimed range in the buffer.

length() - Method in class io.aeron.logbuffer.ExclusiveBufferClaim

The length of the claimed range in the buffer.

length() - Method in class io.aeron.protocol.NakFlyweight

The length field

length(int) - Method in class io.aeron.protocol.NakFlyweight

set length field

lengthOffset(int) - Static method in class io.aeron.logbuffer.FrameDescriptor

The buffer offset at which the length field begins.

limit() - Method in class io.aeron.BufferBuilder

The current limit of the buffer that has been used by append operations.

limit(int) - Method in class io.aeron.BufferBuilder

Set this limit for this buffer as the position at which the next append operation will occur.

LOG_ACTIVE_PARTITION_INDEX_OFFSET - Static variable in class io.aeron.logbuffer.LogBufferDescriptor

Offset within the log meta data where the active partition index is stored.

LOG_CORRELATION_ID_OFFSET - Static variable in class io.aeron.logbuffer.LogBufferDescriptor

Offset within the log meta data which the

LOG_DEFAULT_FRAME_HEADER_LENGTH_OFFSET - Static variable in class io.aeron.logbuffer.LogBufferDescriptor

Offset within the log meta data which the length field for the frame header is stored.

LOG_DEFAULT_FRAME_HEADER_MAX_LENGTH - Static variable in class io.aeron.logbuffer.LogBufferDescriptor

Maximum length of a frame header.

LOG_DEFAULT_FRAME_HEADER_OFFSET - Static variable in class io.aeron.logbuffer.LogBufferDescriptor

Offset at which the default frame headers begin.

LOG_INITIAL_TERM_ID_OFFSET - Static variable in class io.aeron.logbuffer.LogBufferDescriptor

Offset within the log meta data where the active term id is stored.

LOG_META_DATA_LENGTH - Static variable in class io.aeron.logbuffer.LogBufferDescriptor

Total length of the log meta data buffer in bytes.

LOG_META_DATA_SECTION_INDEX - Static variable in class io.aeron.logbuffer.LogBufferDescriptor

Section index for which buffer contains the log meta data.

LOG_MTU_LENGTH_OFFSET - Static variable in class io.aeron.logbuffer.LogBufferDescriptor

Offset within the log meta data which the MTU length is stored;

LOG_TIME_OF_LAST_SM_OFFSET - Static variable in class io.aeron.logbuffer.LogBufferDescriptor

Offset within the log meta data where the time of last SM is stored.

LogBufferDescriptor - Class in io.aeron.logbuffer

Layout description for log buffers which contains partitions of terms with associated term meta data, plus ending with overall log meta data.

LogBufferDescriptor() - Constructor for class io.aeron.logbuffer.LogBufferDescriptor

LogBuffers - Class in io.aeron

Takes a log file name and maps the file into memory and wraps it with UnsafeBuffers as appropriate.

LogBuffers(String, FileChannel.MapMode) - Constructor for class io.aeron.LogBuffers

logBuffersFactory(LogBuffersFactory) - Method in class io.aeron.Aeron.Context

This method is used for testing and debugging.

logBuffersFactory() - Method in class io.aeron.Aeron.Context

Get the factory for making log buffers.

LogBufferUnblocker - Class in io.aeron.logbuffer

Provides the functionality to unblock a log at a given position.

LogBufferUnblocker() - Constructor for class io.aeron.logbuffer.LogBufferUnblocker

logFileName() - Method in class io.aeron.command.ImageBuffersReadyFlyweight

Return the Log Filename in ASCII

logFileName(String) - Method in class io.aeron.command.ImageBuffersReadyFlyweight

Set the log filename in ASCII

logFileName() - Method in class io.aeron.command.PublicationBuffersReadyFlyweight

Get the log file name in ASCII.

logFileName(String) - Method in class io.aeron.command.PublicationBuffersReadyFlyweight

Set the log file name in ASCII.

M

mapExistingCncFile(Consumer<String>) - Method in class io.aeron.CommonContext

Map the CnC file if it exists.

MAX_CAPACITY - Static variable in class io.aeron.BufferBuilder

Maximum capacity to which the array can grow.

maxMessageLength() - Method in class io.aeron.ExclusivePublication

Maximum message length supported in bytes.

maxMessageLength() - Method in class io.aeron.Publication

Maximum message length supported in bytes.

maxPayloadLength() - Method in class io.aeron.ExclusivePublication

Maximum length of a message payload that fits within a message fragment.

maxPayloadLength() - Method in class io.aeron.Publication

Maximum length of a message payload that fits within a message fragment.

MDC_CONTROL_MODE - Static variable in class io.aeron.CommonContext

Key for the mode of control that such be used for multi-destination-cast semantics.

MDC_CONTROL_MODE_MANUAL - Static variable in class io.aeron.CommonContext

Valid value for CommonContext.MDC_CONTROL_MODE when manual control is desired.

META_DATA_LENGTH - Static variable in class io.aeron.CncFileDescriptor

metaDataBuffer() - Method in class io.aeron.LogBuffers

MSG_BUFFER_CAPACITY - Static variable in class io.aeron.DriverProxy

Maximum capacity of the write buffer

MTU_LENGTH_URI_PARAM_NAME - Static variable in class io.aeron.CommonContext

MTU length parameter name for using as a channel URI param.

mtuLength(UnsafeBuffer) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Get the value of the MTU length used for this log.

mtuLength(UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Set the MTU length used for this log.

mtuLength() - Method in class io.aeron.protocol.SetupFlyweight

Return MTU length field

mtuLength(int) - Method in class io.aeron.protocol.SetupFlyweight

Set MTU length field

N

NakFlyweight - Class in io.aeron.protocol

Flyweight for a Nak Packet Data Recovery

NakFlyweight() - Constructor for class io.aeron.protocol.NakFlyweight

NakFlyweight(ByteBuffer) - Constructor for class io.aeron.protocol.NakFlyweight

NakFlyweight(UnsafeBuffer) - Constructor for class io.aeron.protocol.NakFlyweight

nanoClock(NanoClock) - Method in class io.aeron.Aeron.Context

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

nanoClock() - Method in class io.aeron.Aeron.Context

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

newDefaultCncFile() - Static method in class io.aeron.CommonContext

Create a new command and control file in the administration directory.

nextCorrelationId() - Method in class io.aeron.Aeron

Generate the next correlation id that is unique for the connected Media Driver.

nextPartitionIndex(int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Rotate to the next partition in sequence for the term id.

NOT_CONNECTED - Static variable in class io.aeron.ExclusivePublication

The publication is not yet connected to a subscriber.

NOT_CONNECTED - Static variable in class io.aeron.Publication

The publication is not yet connected to a subscriber.

O

offendingCommandCorrelationId() - Method in class io.aeron.command.ErrorResponseFlyweight

Return correlation ID of the offending command.

offendingCommandCorrelationId(long) - Method in class io.aeron.command.ErrorResponseFlyweight

Set correlation ID of the offending command.

offer(DirectBuffer) - Method in class io.aeron.ExclusivePublication

Non-blocking publish of a buffer containing a message.

offer(DirectBuffer, int, int) - Method in class io.aeron.ExclusivePublication

Non-blocking publish of a partial buffer containing a message.

offer(DirectBuffer, int, int, ReservedValueSupplier) - Method in class io.aeron.ExclusivePublication

Non-blocking publish of a partial buffer containing a message.

offer(DirectBuffer) - Method in class io.aeron.Publication

Non-blocking publish of a buffer containing a message.

offer(DirectBuffer, int, int) - Method in class io.aeron.Publication

Non-blocking publish of a partial buffer containing a message.

offer(DirectBuffer, int, int, ReservedValueSupplier) - Method in class io.aeron.Publication

Non-blocking publish of a partial buffer containing a message.

offset - Variable in class io.aeron.command.CorrelatedMessageFlyweight

offset() - Method in class io.aeron.logbuffer.BufferClaim

The offset in the buffer at which the claimed range begins.

offset() - Method in class io.aeron.logbuffer.ExclusiveBufferClaim

The offset in the buffer at which the claimed range begins.

offset(int) - Method in class io.aeron.logbuffer.Header

Set the offset at which the header begins in the log.

offset() - Method in class io.aeron.logbuffer.Header

The offset at which the frame begins.

offset(long) - Static method in class io.aeron.logbuffer.TermReader

The offset up to which the term has progressed.

ON_AVAILABLE_IMAGE - Static variable in class io.aeron.command.ControlProtocolEvents

Subscribed Image buffers are available notification.

ON_ERROR - Static variable in class io.aeron.command.ControlProtocolEvents

Error Response as a result of attempting to process a client command operation.

ON_EXCLUSIVE_PUBLICATION_READY - Static variable in class io.aeron.command.ControlProtocolEvents

New Exclusive Publication buffers are ready notification.

ON_OPERATION_SUCCESS - Static variable in class io.aeron.command.ControlProtocolEvents

Operation has succeeded.

ON_PUBLICATION_READY - Static variable in class io.aeron.command.ControlProtocolEvents

New Publication buffers are ready notification.

ON_UNAVAILABLE_IMAGE - Static variable in class io.aeron.command.ControlProtocolEvents

Inform client of timeout and removal of an inactive Image.

onAvailableImage(Image) - Method in interface io.aeron.AvailableImageHandler

Method called by Aeron to deliver notification of a new Image being available for polling.

onBlock(DirectBuffer, int, int, int, int) - Method in interface io.aeron.logbuffer.BlockHandler

Callback for handling a block of messages being read from a log.

onBlock(FileChannel, long, UnsafeBuffer, int, int, int, int) - Method in interface io.aeron.logbuffer.RawBlockHandler

Notification of an available block of fragments.

onFragment(DirectBuffer, int, int, Header) - Method in class io.aeron.ControlledFragmentAssembler

The implementation of ControlledFragmentHandler that reassembles and forwards whole messages.

onFragment(DirectBuffer, int, int, Header) - Method in class io.aeron.FragmentAssembler

The implementation of FragmentHandler that reassembles and forwards whole messages.

onFragment(DirectBuffer, int, int, Header) - Method in class io.aeron.ImageControlledFragmentAssembler

The implementation of ControlledFragmentHandler that reassembles and forwards whole messages.

onFragment(DirectBuffer, int, int, Header) - Method in class io.aeron.ImageFragmentAssembler

The implementation of FragmentHandler that reassembles and forwards whole messages.

onFragment(DirectBuffer, int, int, Header) - Method in interface io.aeron.logbuffer.ControlledFragmentHandler

Callback for handling fragments of data being read from a log.

onFragment(DirectBuffer, int, int, Header) - Method in interface io.aeron.logbuffer.FragmentHandler

Callback for handling fragments of data being read from a log.

onGap(int, int, int) - Method in interface io.aeron.logbuffer.TermGapScanner.GapHandler

Gap detected in log buffer that is being rebuilt.

onUnavailableImage(Image) - Method in interface io.aeron.UnavailableImageHandler

Method called by Aeron to deliver notification that an Image is no longer available for polling.

P

p16 - Variable in class io.aeron.Subscription

p17 - Variable in class io.aeron.Subscription

p18 - Variable in class io.aeron.Subscription

p19 - Variable in class io.aeron.Subscription

p20 - Variable in class io.aeron.Subscription

p21 - Variable in class io.aeron.Subscription

p22 - Variable in class io.aeron.Subscription

p23 - Variable in class io.aeron.Subscription

p24 - Variable in class io.aeron.Subscription

p25 - Variable in class io.aeron.Subscription

p26 - Variable in class io.aeron.Subscription

p27 - Variable in class io.aeron.Subscription

p28 - Variable in class io.aeron.Subscription

p29 - Variable in class io.aeron.Subscription

p30 - Variable in class io.aeron.Subscription

pack(int, int) - Static method in class io.aeron.logbuffer.TermAppender

Pack the values for termOffset and termId into a long for returning on the stack.

pack(int, int) - Static method in class io.aeron.logbuffer.TermReader

Pack the values for fragmentsRead and offset into a long for returning on the stack.

pack(int, int) - Static method in class io.aeron.logbuffer.TermScanner

Pack the values for available and padding into a long for returning on the stack.

packTail(int, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Pack a termId and termOffset into a raw tail value.

padding(long) - Static method in class io.aeron.logbuffer.TermScanner

The count of bytes that should be added for padding to the position on top of what is available

PADDING_FRAME_TYPE - Static variable in class io.aeron.logbuffer.FrameDescriptor

Padding frame type to indicate the message should be ignored.

PARTITION_COUNT - Static variable in class io.aeron.logbuffer.LogBufferDescriptor

The number of partitions the log is divided into.

poll(FragmentHandler, int) - Method in class io.aeron.Image

Poll for new messages in a stream.

poll(FragmentHandler, int) - Method in class io.aeron.Subscription

Poll the Images under the subscription for available message fragments.

position() - Method in class io.aeron.ExclusivePublication

Get the current position to which the publication has advanced for this stream.

position() - Method in class io.aeron.Image

The position this Image has been consumed to by the subscriber.

position(long) - Method in class io.aeron.Image

Set the subscriber position for this Image to indicate where it has been consumed to.

position() - Method in class io.aeron.logbuffer.Header

Get the current position to which the image has advanced on reading this message.

position() - Method in class io.aeron.Publication

Get the current position to which the publication has advanced for this stream.

positionIndicatorRegistrationId(int, long) - Method in class io.aeron.command.ImageBuffersReadyFlyweight

Set the registration Id for the subscriber position

positionIndicatorRegistrationId(int) - Method in class io.aeron.command.ImageBuffersReadyFlyweight

Return the registration Id for the subscriber position

positionLimit() - Method in class io.aeron.ExclusivePublication

Get the position limit beyond which this ExclusivePublication will be back pressured.

positionLimit() - Method in class io.aeron.Publication

Get the position limit beyond which this Publication will be back pressured.

Publication - Class in io.aeron

Aeron Publisher API for sending messages to subscribers of a given channel and streamId pair.

PUBLICATION_CONNECTION_TIMEOUT_MS - Static variable in class io.aeron.Aeron

Timeout after which if no status messages have been received then a publication is considered not connected.

PublicationBuffersReadyFlyweight - Class in io.aeron.command

Message to denote that new buffers have been setup for a publication.

PublicationBuffersReadyFlyweight() - Constructor for class io.aeron.command.PublicationBuffersReadyFlyweight

publicationConnectionTimeout(long) - Method in class io.aeron.Aeron.Context

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

publicationConnectionTimeout() - Method in class io.aeron.Aeron.Context

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

publicationLimitCounterId() - Method in class io.aeron.command.PublicationBuffersReadyFlyweight

The publication limit counter id.

publicationLimitCounterId(int) - Method in class io.aeron.command.PublicationBuffersReadyFlyweight

set position counter id field

PublicationMessageFlyweight - Class in io.aeron.command

Control message for adding or removing a publication 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Correlation ID | | | +---------------------------------------------------------------+ | Stream ID | +---------------------------------------------------------------+ | Channel Length | +---------------------------------------------------------------+ | Channel (ASCII) ...

PublicationMessageFlyweight() - Constructor for class io.aeron.command.PublicationMessageFlyweight

R

RawBlockHandler - Interface in io.aeron.logbuffer

Function for handling a raw block of fragments from the log that are contained in the underlying file.

rawPoll(RawBlockHandler, int) - Method in class io.aeron.Image

Poll for new messages in a stream.

rawPoll(RawBlockHandler, int) - Method in class io.aeron.Subscription

Poll the Images under the subscription for available message fragments in blocks.

rawTail() - Method in class io.aeron.logbuffer.ExclusiveTermAppender

Get the raw value of the current tail.

rawTail(UnsafeBuffer, int, long) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Set the raw value of the tail for the given partition.

rawTailVolatile(UnsafeBuffer, int, long) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Set the raw value of the tail for the given partition.

rawTailVolatile(UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Get the raw value of the tail for the given partition.

rawTailVolatile(UnsafeBuffer) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Get the raw value of the tail for the current active partition.

rawTailVolatile() - Method in class io.aeron.logbuffer.TermAppender

Get the raw current tail value in a volatile memory ordering fashion.

read(UnsafeBuffer, int, FragmentHandler, int, Header, ErrorHandler, long, Position) - Static method in class io.aeron.logbuffer.TermReader

Reads data from a term in a log buffer and updates a passed Position so progress is not lost in the event of an exception.

read(UnsafeBuffer, int, FragmentHandler, int, Header, ErrorHandler) - Static method in class io.aeron.logbuffer.TermReader

Reads data from a term in a log buffer.

receiverId() - Method in class io.aeron.protocol.RttMeasurementFlyweight

receiverId(long) - Method in class io.aeron.protocol.RttMeasurementFlyweight

receiverId() - Method in class io.aeron.protocol.StatusMessageFlyweight

receiverId(long) - Method in class io.aeron.protocol.StatusMessageFlyweight

receiverWindowLength() - Method in class io.aeron.protocol.StatusMessageFlyweight

return receiver window field

receiverWindowLength(int) - Method in class io.aeron.protocol.StatusMessageFlyweight

set receiver window field

receptionDelta() - Method in class io.aeron.protocol.RttMeasurementFlyweight

receptionDelta(long) - Method in class io.aeron.protocol.RttMeasurementFlyweight

registrationCorrelationId() - Method in class io.aeron.command.DestinationMessageFlyweight

return correlation id used in registration field

registrationCorrelationId(long) - Method in class io.aeron.command.DestinationMessageFlyweight

set registration correlation id field

registrationCorrelationId() - Method in class io.aeron.command.SubscriptionMessageFlyweight

return correlation id used in registration field

registrationCorrelationId(long) - Method in class io.aeron.command.SubscriptionMessageFlyweight

set registration correlation id field

RegistrationException - Exception in io.aeron.exceptions

Caused when a error occurs during addition or release of Publications or Subscriptions

RegistrationException(ErrorCode, String) - Constructor for exception io.aeron.exceptions.RegistrationException

registrationId() - Method in class io.aeron.command.RemoveMessageFlyweight

Get the registration id field

registrationId(long) - Method in class io.aeron.command.RemoveMessageFlyweight

Set registration id field

registrationId() - Method in class io.aeron.ExclusivePublication

Return the registration id used to register this Publication with the media driver.

registrationId() - Method in class io.aeron.Publication

Return the registration id used to register this Publication with the media driver.

registrationId() - Method in class io.aeron.Subscription

Return the registration id used to register this Publication with the media driver.

RELIABLE_STREAM_PARAM_NAME - Static variable in class io.aeron.CommonContext

Parameter name for channel URI param to indicate if a subscribed must be reliable or not.

REMOVE_DESTINATION - Static variable in class io.aeron.command.ControlProtocolEvents

Remove Destination from an existing Publication.

REMOVE_PUBLICATION - Static variable in class io.aeron.command.ControlProtocolEvents

Remove a Publication.

REMOVE_SUBSCRIPTION - Static variable in class io.aeron.command.ControlProtocolEvents

Remove a Subscriber.

removeDestination(long, String) - Method in class io.aeron.DriverProxy

removeDestination(String) - Method in class io.aeron.ExclusivePublication

Remove a previously added destination manually from a multi-destination-cast Publication.

removeDestination(String) - Method in class io.aeron.Publication

Remove a previously added destination manually from a multi-destination-cast Publication.

RemoveMessageFlyweight - Class in io.aeron.command

Control message for removing a Publication or Subscription.

RemoveMessageFlyweight() - Constructor for class io.aeron.command.RemoveMessageFlyweight

removePublication(long) - Method in class io.aeron.DriverProxy

removeSubscription(long) - Method in class io.aeron.DriverProxy

REPLY_FLAG - Static variable in class io.aeron.protocol.RttMeasurementFlyweight

RESERVED_VALUE_OFFSET - Static variable in class io.aeron.protocol.DataHeaderFlyweight

reservedValue() - Method in class io.aeron.logbuffer.BufferClaim

Get the value stored in the reserve space at the end of a data frame header.

reservedValue(long) - Method in class io.aeron.logbuffer.BufferClaim

Write the provided value into the reserved space at the end of the data frame header.

reservedValue() - Method in class io.aeron.logbuffer.ExclusiveBufferClaim

Get the value stored in the reserve space at the end of a data frame header.

reservedValue(long) - Method in class io.aeron.logbuffer.ExclusiveBufferClaim

Write the provided value into the reserved space at the end of the data frame header.

reservedValue() - Method in class io.aeron.logbuffer.Header

Get the value stored in the reserve space at the end of a data frame header.

reservedValue() - Method in class io.aeron.protocol.DataHeaderFlyweight

Get the reserved value in LITTLE_ENDIAN format.

reservedValue(long) - Method in class io.aeron.protocol.DataHeaderFlyweight

Set the reserved value in LITTLE_ENDIAN format.

ReservedValueSupplier - Interface in io.aeron

Supplies the reserved value field for a data frame header.

reset() - Method in class io.aeron.BufferBuilder

Reset the builder to restart append operations.

rotateLog(UnsafeBuffer, int, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Rotate the log and update the default headers for the new term.

RttMeasurementFlyweight - Class in io.aeron.protocol

Flyweight for an RTT Measurement Packet RTT Measurement Header

RttMeasurementFlyweight() - Constructor for class io.aeron.protocol.RttMeasurementFlyweight

RttMeasurementFlyweight(ByteBuffer) - Constructor for class io.aeron.protocol.RttMeasurementFlyweight

RttMeasurementFlyweight(UnsafeBuffer) - Constructor for class io.aeron.protocol.RttMeasurementFlyweight

S

saveErrorLog(PrintStream) - Method in class io.aeron.CommonContext

Read the error log to a given PrintStream

saveErrorLog(PrintStream, MappedByteBuffer) - Method in class io.aeron.CommonContext

Read the error log to a given PrintStream

scan(UnsafeBuffer, int, int) - Static method in class io.aeron.logbuffer.TermBlockScanner

Scan a term buffer for a block of messages from an offset up to a limit.

scanForAvailability(UnsafeBuffer, int, int) - Static method in class io.aeron.logbuffer.TermScanner

Scan the term buffer for availability of new messages from a given offset up to a maxLength of bytes.

scanForGap(UnsafeBuffer, int, int, int, TermGapScanner.GapHandler) - Static method in class io.aeron.logbuffer.TermGapScanner

Scan for gaps from the scanOffset up to a limit offset.

SEND_SETUP_FLAG - Static variable in class io.aeron.protocol.StatusMessageFlyweight

Publisher should send SETUP frame

sendClientKeepalive() - Method in class io.aeron.DriverProxy

SESSION_ID_FIELD_OFFSET - Static variable in class io.aeron.protocol.DataHeaderFlyweight

sessionId() - Method in class io.aeron.command.ImageBuffersReadyFlyweight

return session id field

sessionId(int) - Method in class io.aeron.command.ImageBuffersReadyFlyweight

set session id field

sessionId() - Method in class io.aeron.command.PublicationBuffersReadyFlyweight

return session id field

sessionId(int) - Method in class io.aeron.command.PublicationBuffersReadyFlyweight

set session id field

sessionId() - Method in class io.aeron.ExclusivePublication

Session under which messages are published.

sessionId() - Method in class io.aeron.Image

The sessionId for the steam of messages.

sessionId() - Method in class io.aeron.logbuffer.Header

The session ID to which the frame belongs.

sessionId() - Method in class io.aeron.protocol.DataHeaderFlyweight

return session id field

sessionId(int) - Method in class io.aeron.protocol.DataHeaderFlyweight

set session id field

sessionId() - Method in class io.aeron.protocol.NakFlyweight

return session id field

sessionId(int) - Method in class io.aeron.protocol.NakFlyweight

set session id field

sessionId() - Method in class io.aeron.protocol.RttMeasurementFlyweight

return session id field

sessionId(int) - Method in class io.aeron.protocol.RttMeasurementFlyweight

set session id field

sessionId() - Method in class io.aeron.protocol.SetupFlyweight

return session id field

sessionId(int) - Method in class io.aeron.protocol.SetupFlyweight

set session id field

sessionId() - Method in class io.aeron.protocol.StatusMessageFlyweight

return session id field

sessionId(int) - Method in class io.aeron.protocol.StatusMessageFlyweight

set session id field

sessionId() - Method in class io.aeron.Publication

Session under which messages are published.

SetupFlyweight - Class in io.aeron.protocol

HeaderFlyweight for Setup Frames Stream Setup

SetupFlyweight() - Constructor for class io.aeron.protocol.SetupFlyweight

SetupFlyweight(UnsafeBuffer) - Constructor for class io.aeron.protocol.SetupFlyweight

SetupFlyweight(ByteBuffer) - Constructor for class io.aeron.protocol.SetupFlyweight

sourceIdentity() - Method in class io.aeron.command.ImageBuffersReadyFlyweight

Return the source identity string in ASCII

sourceIdentity(String) - Method in class io.aeron.command.ImageBuffersReadyFlyweight

Set the source identity string in ASCII

sourceIdentity() - Method in class io.aeron.Image

The source identity of the sending publisher as an abstract concept appropriate for the media.

SPY_PREFIX - Static variable in class io.aeron.CommonContext

URI used for Spy Subscriptions whereby an outgoing unicast or multicast publication can be spied on by IPC without receiving it again via the network.

StatusMessageFlyweight - Class in io.aeron.protocol

Flyweight for a Status Message Packet

StatusMessageFlyweight() - Constructor for class io.aeron.protocol.StatusMessageFlyweight

StatusMessageFlyweight(ByteBuffer) - Constructor for class io.aeron.protocol.StatusMessageFlyweight

StatusMessageFlyweight(UnsafeBuffer) - Constructor for class io.aeron.protocol.StatusMessageFlyweight

storeDefaultFrameHeader(UnsafeBuffer, DirectBuffer) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Store the default frame header to the log meta data buffer.

STREAM_ID_FIELD_OFFSET - Static variable in class io.aeron.protocol.DataHeaderFlyweight

streamId() - Method in class io.aeron.command.ImageBuffersReadyFlyweight

return stream id field

streamId(int) - Method in class io.aeron.command.ImageBuffersReadyFlyweight

set stream id field

streamId() - Method in class io.aeron.command.ImageMessageFlyweight

return stream id field

streamId(int) - Method in class io.aeron.command.ImageMessageFlyweight

set stream id field

streamId() - Method in class io.aeron.command.PublicationBuffersReadyFlyweight

return stream id field

streamId(int) - Method in class io.aeron.command.PublicationBuffersReadyFlyweight

set stream id field

streamId() - Method in class io.aeron.command.PublicationMessageFlyweight

Get the stream id field

streamId(int) - Method in class io.aeron.command.PublicationMessageFlyweight

Set the stream id field

streamId() - Method in class io.aeron.command.SubscriptionMessageFlyweight

return the stream id

streamId(int) - Method in class io.aeron.command.SubscriptionMessageFlyweight

Set the stream id

streamId() - Method in class io.aeron.ExclusivePublication

Stream identity for scoping within the channel media address.

streamId() - Method in class io.aeron.logbuffer.Header

The stream ID to which the frame belongs.

streamId() - Method in class io.aeron.protocol.DataHeaderFlyweight

return stream id field

streamId(int) - Method in class io.aeron.protocol.DataHeaderFlyweight

set stream id field

streamId() - Method in class io.aeron.protocol.NakFlyweight

return stream id field

streamId(int) - Method in class io.aeron.protocol.NakFlyweight

set stream id field

streamId() - Method in class io.aeron.protocol.RttMeasurementFlyweight

return stream id field

streamId(int) - Method in class io.aeron.protocol.RttMeasurementFlyweight

set stream id field

streamId() - Method in class io.aeron.protocol.SetupFlyweight

return stream id field

streamId(int) - Method in class io.aeron.protocol.SetupFlyweight

set stream id field

streamId() - Method in class io.aeron.protocol.StatusMessageFlyweight

return stream id field

streamId(int) - Method in class io.aeron.protocol.StatusMessageFlyweight

set stream id field

streamId() - Method in class io.aeron.Publication

Stream identity for scoping within the channel media address.

streamId() - Method in class io.aeron.Subscription

Stream identity for scoping within the channel media address.

subscriberPositionCount() - Method in class io.aeron.command.ImageBuffersReadyFlyweight

return the number of position indicators

subscriberPositionCount(int) - Method in class io.aeron.command.ImageBuffersReadyFlyweight

set the number of position indicators

subscriberPositionId(int, int) - Method in class io.aeron.command.ImageBuffersReadyFlyweight

Set the position Id for the subscriber

subscriberPositionId(int) - Method in class io.aeron.command.ImageBuffersReadyFlyweight

Return the position Id for the subscriber

subscription() - Method in class io.aeron.Image

Get the Subscription to which this Image belongs.

Subscription - Class in io.aeron

Aeron Subscriber API for receiving a reconstructed Image for a stream of messages from publishers on a given channel and streamId pair.

SubscriptionMessageFlyweight - Class in io.aeron.command

Control message for adding or removing a subscription.

SubscriptionMessageFlyweight() - Constructor for class io.aeron.command.SubscriptionMessageFlyweight

T

tailTermId(int) - Method in class io.aeron.logbuffer.ExclusiveTermAppender

Set the value for the tail counter.

tailTermId(int) - Method in class io.aeron.logbuffer.TermAppender

Set the value for the tail counter.

TERM_ID_FIELD_OFFSET - Static variable in class io.aeron.protocol.DataHeaderFlyweight

TERM_ID_OFFSET - Static variable in class io.aeron.logbuffer.FrameDescriptor

Offset within a frame at which the term id field begins

TERM_ID_PARAM_NAME - Static variable in class io.aeron.CommonContext

Current term id to be used when creating an ExclusivePublication.

TERM_LENGTH_PARAM_NAME - Static variable in class io.aeron.CommonContext

The param name to be used for the term length as a channel URI param.

TERM_MIN_LENGTH - Static variable in class io.aeron.logbuffer.LogBufferDescriptor

Minimum buffer length for a log term

TERM_OFFSET - Static variable in class io.aeron.logbuffer.FrameDescriptor

Offset within a frame at which the term offset field begins

TERM_OFFSET_FIELD_OFFSET - Static variable in class io.aeron.protocol.DataHeaderFlyweight

TERM_OFFSET_PARAM_NAME - Static variable in class io.aeron.CommonContext

Current term offset to be used when creating an ExclusivePublication.

TERM_TAIL_COUNTERS_OFFSET - Static variable in class io.aeron.logbuffer.LogBufferDescriptor

Offset within the meta data where the tail values are stored.

TermAppender - Class in io.aeron.logbuffer

Term buffer appender which supports many producers concurrently writing an append-only log.

TermAppender(UnsafeBuffer, UnsafeBuffer, int) - Constructor for class io.aeron.logbuffer.TermAppender

Construct a view over a term buffer and state buffer for appending frames.

TermBlockScanner - Class in io.aeron.logbuffer

Scan a term buffer for a block of messages including padding.

TermBlockScanner() - Constructor for class io.aeron.logbuffer.TermBlockScanner

termBufferLength() - Method in class io.aeron.ExclusivePublication

Get the length in bytes for each term partition in the log buffer.

termBufferLength() - Method in class io.aeron.Image

Get the length in bytes for each term partition in the log buffer.

termBufferLength() - Method in class io.aeron.Publication

Get the length in bytes for each term partition in the log buffer.

termBuffers() - Method in class io.aeron.LogBuffers

TermGapFiller - Class in io.aeron.logbuffer

Fills a gap in a term with a padding record.

TermGapFiller() - Constructor for class io.aeron.logbuffer.TermGapFiller

TermGapScanner - Class in io.aeron.logbuffer

Scans for gaps in the sequence of bytes in a replicated term buffer between the completed rebuild and the high-water-mark.

TermGapScanner() - Constructor for class io.aeron.logbuffer.TermGapScanner

TermGapScanner.GapHandler - Interface in io.aeron.logbuffer

Handler for notifying of gaps in the log.

termId() - Method in class io.aeron.logbuffer.Header

The term ID to which the frame belongs.

termId(long) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Get the termId from a packed raw tail value.

termId(long) - Static method in class io.aeron.logbuffer.TermAppender

The termId in which the append operation took place.

termId() - Method in class io.aeron.protocol.DataHeaderFlyweight

return term id field

termId(int) - Method in class io.aeron.protocol.DataHeaderFlyweight

set term id field

termId() - Method in class io.aeron.protocol.NakFlyweight

return term id field

termId(int) - Method in class io.aeron.protocol.NakFlyweight

set term id field

termIdOffset(int) - Static method in class io.aeron.logbuffer.FrameDescriptor

The buffer offset at which the term id field begins.

termLength() - Method in class io.aeron.LogBuffers

termLength() - Method in class io.aeron.protocol.SetupFlyweight

return term length field

termLength(int) - Method in class io.aeron.protocol.SetupFlyweight

set term length field

termOffset() - Method in class io.aeron.logbuffer.Header

The offset in the term at which the frame begins.

termOffset(long, long) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Read the termOffset from a packed raw tail value.

termOffset(long) - Static method in class io.aeron.logbuffer.TermAppender

The termOffset as a result of the append

termOffset() - Method in class io.aeron.protocol.DataHeaderFlyweight

return term offset field

termOffset(int) - Method in class io.aeron.protocol.DataHeaderFlyweight

set term offset field

termOffset() - Method in class io.aeron.protocol.NakFlyweight

return term offset field

termOffset(int) - Method in class io.aeron.protocol.NakFlyweight

set term offset field

termOffset() - Method in class io.aeron.protocol.SetupFlyweight

return term offset field

termOffset(int) - Method in class io.aeron.protocol.SetupFlyweight

set term offset field

termOffsetOffset(int) - Static method in class io.aeron.logbuffer.FrameDescriptor

The buffer offset at which the term offset field begins.

TermReader - Class in io.aeron.logbuffer

A term buffer reader.

TermReader() - Constructor for class io.aeron.logbuffer.TermReader

TermRebuilder - Class in io.aeron.logbuffer

Rebuild a term buffer from received frames which can be out-of-order.

TermRebuilder() - Constructor for class io.aeron.logbuffer.TermRebuilder

TermScanner - Class in io.aeron.logbuffer

Scans a term buffer for an availability range of messages.

TermScanner() - Constructor for class io.aeron.logbuffer.TermScanner

TermUnblocker - Class in io.aeron.logbuffer

Unblocks a term buffer if a publisher has died leaving the log with a partial log entry.

TermUnblocker() - Constructor for class io.aeron.logbuffer.TermUnblocker

TermUnblocker.Status - Enum in io.aeron.logbuffer

threadFactory(ThreadFactory) - Method in class io.aeron.Aeron.Context

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

threadFactory() - Method in class io.aeron.Aeron.Context

The thread factory to be use to construct the conductor thread

timeOfLastDriverKeepalive() - Method in class io.aeron.DriverProxy

timeOfLastStatusMessage(UnsafeBuffer) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Get the value of the time of last SM in System.currentTimeMillis().

timeOfLastStatusMessage(UnsafeBuffer, long) - Static method in class io.aeron.logbuffer.LogBufferDescriptor

Set the value of the time of last SM used by the producer of this log.

TO_CLIENTS_BUFFER_LENGTH_FIELD_OFFSET - Static variable in class io.aeron.CncFileDescriptor

TO_DRIVER_BUFFER_LENGTH_FIELD_OFFSET - Static variable in class io.aeron.CncFileDescriptor

toClientBuffer(CopyBroadcastReceiver) - Method in class io.aeron.Aeron.Context

This method is used for testing and debugging.

toClientBuffer() - Method in class io.aeron.Aeron.Context

The buffer used for communicating from the media driver to the Aeron client.

toClientsBufferLengthOffset(int) - Static method in class io.aeron.CncFileDescriptor

toDriverBuffer(RingBuffer) - Method in class io.aeron.Aeron.Context

This method is used for testing and debugging.

toDriverBuffer() - Method in class io.aeron.Aeron.Context

Get the RingBuffer used for sending commands to the media driver.

toDriverBufferLengthOffset(int) - Static method in class io.aeron.CncFileDescriptor

toString() - Method in class io.aeron.protocol.DataHeaderFlyweight

toString() - Method in class io.aeron.protocol.NakFlyweight

toString() - Method in class io.aeron.protocol.RttMeasurementFlyweight

toString() - Method in class io.aeron.protocol.SetupFlyweight

toString() - Method in class io.aeron.protocol.StatusMessageFlyweight

TRIPPED - Static variable in class io.aeron.logbuffer.ExclusiveTermAppender

The append operation tripped the end of the buffer and needs to rotate.

TRIPPED - Static variable in class io.aeron.logbuffer.TermAppender

The append operation tripped the end of the buffer and needs to rotate.

tryClaim(int, ExclusiveBufferClaim) - Method in class io.aeron.ExclusivePublication

Try to claim a range in the publication log into which a message can be written with zero copy semantics.

tryClaim(int, BufferClaim) - Method in class io.aeron.Publication

Try to claim a range in the publication log into which a message can be written with zero copy semantics.

tryFillGap(UnsafeBuffer, UnsafeBuffer, int, int, int) - Static method in class io.aeron.logbuffer.TermGapFiller

Try to gap fill the current term at a given offset if the gap contains no data.

ttl() - Method in class io.aeron.protocol.SetupFlyweight

Return the TTL field

ttl(int) - Method in class io.aeron.protocol.SetupFlyweight

Set the TTL field

type() - Method in class io.aeron.logbuffer.Header

The type of the the frame which should always be HeaderFlyweight.HDR_TYPE_DATA

TYPE_FIELD_OFFSET - Static variable in class io.aeron.protocol.HeaderFlyweight

TYPE_OFFSET - Static variable in class io.aeron.logbuffer.FrameDescriptor

Offset within a frame at which the type field begins

typeOffset(int) - Static method in class io.aeron.logbuffer.FrameDescriptor

The buffer offset at which the type field begins.

U

unavailableImageHandler(UnavailableImageHandler) - Method in class io.aeron.Aeron.Context

Setup a default callback for when an Image is unavailable.

unavailableImageHandler() - Method in class io.aeron.Aeron.Context

Get the callback handler for when an Image is unavailable.

unavailableImageHandler() - Method in class io.aeron.Subscription

Callback used to indicate when an Image goes unavailable under this Subscription.

UnavailableImageHandler - Interface in io.aeron

Interface for delivery of inactive image notification to a Subscription.

unblock(UnsafeBuffer[], UnsafeBuffer, long) - Static method in class io.aeron.logbuffer.LogBufferUnblocker

Attempt to unblock a log buffer at given position

unblock(UnsafeBuffer, UnsafeBuffer, int, int, int) - Static method in class io.aeron.logbuffer.TermUnblocker

Attempt to unblock the current term at the current offset.

UNFRAGMENTED - Static variable in class io.aeron.logbuffer.FrameDescriptor

End fragment of a frame.

V

value() - Method in enum io.aeron.ErrorCode

Get the value of this ErrorCode.

valueOf(String) - Static method in enum io.aeron.ErrorCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.aeron.logbuffer.ControlledFragmentHandler.Action

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.aeron.logbuffer.TermUnblocker.Status

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.aeron.ErrorCode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.aeron.logbuffer.ControlledFragmentHandler.Action

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.aeron.logbuffer.TermUnblocker.Status

Returns an array containing the constants of this enum type, in the order they are declared.

version() - Method in class io.aeron.protocol.HeaderFlyweight

return version field value

version(short) - Method in class io.aeron.protocol.HeaderFlyweight

set version field value

VERSION_FIELD_OFFSET - Static variable in class io.aeron.protocol.HeaderFlyweight

VERSION_OFFSET - Static variable in class io.aeron.logbuffer.FrameDescriptor

Offset within a frame at which the version field begins

versionOffset(int) - Static method in class io.aeron.logbuffer.FrameDescriptor

The buffer offset at which the version field begins.

W

wrap(MutableDirectBuffer, int) - Method in class io.aeron.command.CorrelatedMessageFlyweight

Wrap the buffer at a given offset for updates.

wrap(MutableDirectBuffer, int) - Method in class io.aeron.command.ErrorResponseFlyweight

Wrap the buffer at a given offset for updates.

wrap(MutableDirectBuffer, int) - Method in class io.aeron.command.ImageBuffersReadyFlyweight

Wrap the buffer at a given offset for updates.

wrap(MutableDirectBuffer, int) - Method in class io.aeron.command.ImageMessageFlyweight

Wrap the buffer at a given offset for updates.

wrap(MutableDirectBuffer, int) - Method in class io.aeron.command.PublicationBuffersReadyFlyweight

Wrap the buffer at a given offset for updates.

wrap(AtomicBuffer, int, int) - Method in class io.aeron.logbuffer.BufferClaim

Wrap a region of an underlying log buffer so can can represent a claimed space for use by a publisher.

wrap(AtomicBuffer, int, int) - Method in class io.aeron.logbuffer.ExclusiveBufferClaim

Wrap a region of an underlying log buffer so can can represent a claimed space for use by a publisher.

write(UnsafeBuffer, int, int, int) - Method in class io.aeron.logbuffer.HeaderWriter

Write a header to the term buffer in ByteOrder.LITTLE_ENDIAN format using the minimum instructions.

A B C D E F G H I K L M N O P R S T U V W