Skip navigation links
A B C D E F G H I J 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.
ACTIVE - Static variable in class io.aeron.status.ChannelEndpointStatus
Channel has finished initialization successfully and is active.
activeTermCount(UnsafeBuffer) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Get the value of the active term count used by the producer of this log.
activeTermCount(UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Set the value of the current active partition index for the producer.
activeTermCountOrdered(UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Set the value of the current active term count 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_COUNTER - Static variable in class io.aeron.command.ControlProtocolEvents
Add a Counter to the counters manager.
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_RCV_DESTINATION - Static variable in class io.aeron.command.ControlProtocolEvents
Add Destination for existing Subscription.
ADD_SUBSCRIPTION - Static variable in class io.aeron.command.ControlProtocolEvents
Add a Subscriber.
addCounter(int, DirectBuffer, int, int, DirectBuffer, int, int) - Method in class io.aeron.Aeron
Allocate a counter on the media driver and return a Counter for it.
addCounter(int, String) - Method in class io.aeron.Aeron
Allocate a counter on the media driver and return a Counter for it.
addCounter(int, DirectBuffer, int, int, DirectBuffer, int, int) - Method in class io.aeron.DriverProxy
 
addCounter(int, String) - Method in class io.aeron.DriverProxy
 
addDestination(long, String) - Method in class io.aeron.DriverProxy
 
addDestination(String) - Method in class io.aeron.Publication
Add a destination manually to a multi-destination-cast Publication.
addDestination(String) - Method in class io.aeron.Subscription
Add a destination manually to a multi-destination Subscription.
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
 
addRcvDestination(long, String) - Method in class io.aeron.DriverProxy
 
addSessionId(String, int) - Static method in class io.aeron.ChannelUri
Add a sessionId to a given channel.
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.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.Configuration - Class in io.aeron
Configuration options for the Aeron client.
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.
AERON_SCHEME - Static variable in class io.aeron.ChannelUri
URI Scheme for Aeron channels.
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.
AeronException - Exception in io.aeron.exceptions
Base Aeron exception for catching all Aeron specific errors.
AeronException() - Constructor for exception io.aeron.exceptions.AeronException
 
AeronException(String) - Constructor for exception io.aeron.exceptions.AeronException
 
AeronException(String, Throwable) - Constructor for exception io.aeron.exceptions.AeronException
 
AeronException(Throwable) - Constructor for exception io.aeron.exceptions.AeronException
 
AeronException(String, Throwable, boolean, boolean) - Constructor for exception io.aeron.exceptions.AeronException
 
alias(String) - Method in class io.aeron.ChannelUriStringBuilder
Set the alias for a URI.
alias() - Method in class io.aeron.ChannelUriStringBuilder
Get the alias present in the URI.
ALIAS_PARAM_NAME - Static variable in class io.aeron.CommonContext
Parameter name for channel URI param to indicate an alias for the given URI.
allocate(MutableDirectBuffer, String, int, CountersManager, String) - Static method in class io.aeron.status.ChannelEndpointStatus
Allocate an indicator for tracking the status of a channel endpoint.
allocate(MutableDirectBuffer, String, int, CountersManager, long) - Static method in class io.aeron.status.HeartbeatStatus
Allocate a counter for tracking the last heartbeat of an entity.
allocateCounterId(MutableDirectBuffer, String, int, CountersManager, long) - Static method in class io.aeron.status.HeartbeatStatus
 
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(int, int, HeaderWriter, DirectBuffer, int, int, DirectBuffer, int, int, int, ReservedValueSupplier) - Method in class io.aeron.logbuffer.ExclusiveTermAppender
Append a fragmented message to the the term buffer.
appendFragmentedMessage(int, int, HeaderWriter, DirectBufferVector[], 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, int) - Method in class io.aeron.logbuffer.TermAppender
Append a fragmented message to the the term buffer.
appendFragmentedMessage(HeaderWriter, DirectBuffer, int, int, DirectBuffer, int, int, int, ReservedValueSupplier, int) - Method in class io.aeron.logbuffer.TermAppender
Append a fragmented message to the the term buffer.
appendFragmentedMessage(HeaderWriter, DirectBufferVector[], int, int, ReservedValueSupplier, int) - Method in class io.aeron.logbuffer.TermAppender
Append a fragmented message to the the term buffer.
appendPadding(int) - Method in class io.aeron.ExclusivePublication
Append a padding record log of a given length to make up the log to a position.
appendPadding(int, int, HeaderWriter, int) - Method in class io.aeron.logbuffer.ExclusiveTermAppender
Pad a length of the term buffer with a padding record.
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(int, int, HeaderWriter, DirectBuffer, int, int, DirectBuffer, int, int, ReservedValueSupplier) - Method in class io.aeron.logbuffer.ExclusiveTermAppender
Append an unfragmented message to the the term buffer.
appendUnfragmentedMessage(int, int, HeaderWriter, DirectBufferVector[], int, ReservedValueSupplier) - Method in class io.aeron.logbuffer.ExclusiveTermAppender
Append an unfragmented message to the the term buffer as a gathering of vectors.
appendUnfragmentedMessage(HeaderWriter, DirectBuffer, int, int, DirectBuffer, int, int, ReservedValueSupplier, int) - Method in class io.aeron.logbuffer.TermAppender
Append an unfragmented message to the the term buffer.
appendUnfragmentedMessage(HeaderWriter, DirectBuffer, int, int, ReservedValueSupplier, int) - Method in class io.aeron.logbuffer.TermAppender
Append an unfragmented message to the the term buffer.
appendUnfragmentedMessage(HeaderWriter, DirectBufferVector[], int, ReservedValueSupplier, int) - Method in class io.aeron.logbuffer.TermAppender
Append an unfragmented message to the the term buffer as a gathering of vectors.
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.
authenticate(byte[]) - Method in interface io.aeron.security.SessionProxy
Inform the system that the session has met authentication requirements.
AuthenticationException - Exception in io.aeron.security
Used to indicated a failed authentication attempt when connecting to a system.
AuthenticationException() - Constructor for exception io.aeron.security.AuthenticationException
 
AuthenticationException(String) - Constructor for exception io.aeron.security.AuthenticationException
 
AuthenticationException(String, Throwable) - Constructor for exception io.aeron.security.AuthenticationException
 
AuthenticationException(Throwable) - Constructor for exception io.aeron.security.AuthenticationException
 
AuthenticationException(String, Throwable, boolean, boolean) - Constructor for exception io.aeron.security.AuthenticationException
 
Authenticator - Interface in io.aeron.security
Interface for an Authenticator to handle authentication of clients to a system.
AuthenticatorSupplier - Interface in io.aeron.security
Used to supply instances of Authenticator.
available(long) - Static method in class io.aeron.logbuffer.TermScanner
The number of bytes that are available to be read after a scan.
availableCounterHandler(AvailableCounterHandler) - Method in class io.aeron.Aeron.Context
Setup a callback for when a counter is available.
availableCounterHandler() - Method in class io.aeron.Aeron.Context
Get the callback handler for when a counter is available.
AvailableCounterHandler - Interface in io.aeron
Interface for notification ofCounters becoming available via a Aeron client.
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.
availableWindow() - Method in class io.aeron.ConcurrentPublication
 
availableWindow() - Method in class io.aeron.ExclusivePublication
 
availableWindow() - Method in class io.aeron.Publication
Available window for offering into a publication before the Publication.positionLimit() is reached.

B

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_END_AND_EOS_FLAGS - Static variable in class io.aeron.protocol.DataHeaderFlyweight
Begin, End, and End of Stream 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.
boundedControlledPoll(ControlledFragmentHandler, long, int) - Method in class io.aeron.Image
Poll for new messages in a stream.
buffer() - Method in class io.aeron.BufferBuilder
The MutableDirectBuffer that encapsulates the internal buffer.
buffer - Variable in class io.aeron.command.ClientTimeoutFlyweight
 
buffer - Variable in class io.aeron.command.CorrelatedMessageFlyweight
 
buffer - Variable in class io.aeron.command.OperationSucceededFlyweight
 
buffer - Variable in class io.aeron.DirectBufferVector
 
buffer() - Method in class io.aeron.DirectBufferVector
The buffer which the vector applies to.
buffer(DirectBuffer) - Method in class io.aeron.DirectBufferVector
The buffer which the vector applies to.
buffer - Variable in class io.aeron.logbuffer.BufferClaim
 
buffer() - Method in class io.aeron.logbuffer.BufferClaim
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 buffer fragments which grows internal capacity as needed.
BufferBuilder() - Constructor for class io.aeron.BufferBuilder
Construct a buffer builder with an initial capacity of zero and isDirect false.
BufferBuilder(int) - Constructor for class io.aeron.BufferBuilder
Construct a buffer builder with an initial capacity and isDirect false.
BufferBuilder(int, boolean) - Constructor for class io.aeron.BufferBuilder
Construct a buffer builder with an initial capacity.
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
 
build() - Method in class io.aeron.ChannelUriStringBuilder
Build a channel URI String for the given parameters.

C

capacity() - Method in class io.aeron.BufferBuilder
The current capacity of the buffer.
casActiveTermCount(UnsafeBuffer, int, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Compare and set the value of the current active term count.
casRawTail(UnsafeBuffer, int, long, long) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Compare and set the raw value of the tail for the given partition.
challenge(byte[]) - Method in interface io.aeron.security.SessionProxy
Inform the system that the session requires a challenge and to send the provided encoded challenge.
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 - Variable in class io.aeron.Publication
 
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.
CHANNEL_OFFSET - Static variable in class io.aeron.status.ChannelEndpointStatus
Offset in the key meta data for the channel of the counter.
ChannelEndpointException - Exception in io.aeron.exceptions
 
ChannelEndpointException(int, String) - Constructor for exception io.aeron.exceptions.ChannelEndpointException
 
ChannelEndpointStatus - Class in io.aeron.status
Status for an Aeron media channel for a Publication or Subscription.
ChannelEndpointStatus() - Constructor for class io.aeron.status.ChannelEndpointStatus
 
channelStatus() - Method in class io.aeron.Publication
Get the status of the media channel for this Publication.
channelStatus() - Method in class io.aeron.Subscription
Get the status of the media channel for this Subscription.
channelStatusCounterId() - Method in class io.aeron.command.PublicationBuffersReadyFlyweight
The channel status counter id.
channelStatusCounterId(int) - Method in class io.aeron.command.PublicationBuffersReadyFlyweight
Set channel status counter id field
channelStatusCounterId() - Method in class io.aeron.command.SubscriptionReadyFlyweight
The channel status counter id.
channelStatusCounterId(int) - Method in class io.aeron.command.SubscriptionReadyFlyweight
Set channel status counter id field
channelStatusId - Variable in class io.aeron.Publication
 
channelStatusId() - Method in class io.aeron.Publication
Get the counter used to represent the channel status for this publication.
channelTag() - Method in class io.aeron.ChannelUri
Get the channel tag, if it exists, that refers to an another channel.
ChannelUri - Class in io.aeron
Parser for Aeron channel URIs.
ChannelUri(String, String, Map<String, String>) - Constructor for class io.aeron.ChannelUri
Construct with the components provided to avoid parsing.
ChannelUri(String, Map<String, String>) - Constructor for class io.aeron.ChannelUri
Construct with the components provided to avoid parsing.
ChannelUriStringBuilder - Class in io.aeron
Type safe means of building a channel URI associated with a Publication or Subscription.
ChannelUriStringBuilder() - Constructor for class io.aeron.ChannelUriStringBuilder
 
checkPageSize(int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Check that page size is valid and alignment is valid.
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, BufferClaim) - 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, int) - 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.ChannelUriStringBuilder
Clear out all the values thus setting back to the initial state.
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_CLOSE - Static variable in class io.aeron.command.ControlProtocolEvents
Close indication from Client.
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
 
clientClose() - Method in class io.aeron.DriverProxy
 
clientId() - Method in class io.aeron.Aeron
Get the client identity that has been allocated for communicating with the media driver.
clientId() - Method in class io.aeron.Aeron.Context
Get the client identity that has been allocated for communicating with the media driver.
clientId() - Method in class io.aeron.command.ClientTimeoutFlyweight
return client id field
clientId(long) - Method in class io.aeron.command.ClientTimeoutFlyweight
set client id field
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
clientId() - Method in class io.aeron.DriverProxy
 
clientLivenessTimeout(DirectBuffer) - Static method in class io.aeron.CncFileDescriptor
 
clientLivenessTimeoutOffset(int) - Static method in class io.aeron.CncFileDescriptor
 
clientLock(Lock) - Method in class io.aeron.Aeron.Context
The Lock that is used to provide mutual exclusion in the Aeron client.
clientLock() - Method in class io.aeron.Aeron.Context
Get the Lock that is used to provide mutual exclusion in the Aeron client.
ClientTimeoutException - Exception in io.aeron.exceptions
Client timeout event received from the driver for this client.
ClientTimeoutException(String) - Constructor for exception io.aeron.exceptions.ClientTimeoutException
 
ClientTimeoutFlyweight - Class in io.aeron.command
Indicate a client has timed out by the driver.
ClientTimeoutFlyweight() - Constructor for class io.aeron.command.ClientTimeoutFlyweight
 
clone() - Method in class io.aeron.Aeron.Context
Perform a shallow copy of the object.
clone() - Method in class io.aeron.CommonContext
Perform a shallow copy of the object.
close() - Method in class io.aeron.Aeron
Clean up and release all Aeron client resources and shutdown conductor thread if not using Aeron.Context.useConductorAgentInvoker(boolean).
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.Counter
Close the counter, releasing the resource managed by the media driver if this was the creator of the Counter.
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.status.ReadableCounter
Close this counter.
close() - Method in class io.aeron.Subscription
Close the Subscription so that associated Images can be released.
CLOSED - Static variable in class io.aeron.Publication
The Publication has been closed and should no longer be used.
CLOSING - Static variable in class io.aeron.status.ChannelEndpointStatus
Channel is being closed.
CNC_FILE - 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.
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.
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
 
compact() - Method in class io.aeron.BufferBuilder
Compact the buffer to reclaim unused space above the limit.
computeCncFileLength(int, int) - Static method in class io.aeron.CncFileDescriptor
Compute the length of the cnc file and return it.
computeLogLength(int, 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 termLength.
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.
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.
ConcurrentPublication - Class in io.aeron
Aeron publisher API for sending messages to subscribers of a given channel and streamId pair.
conductor - Variable in class io.aeron.Publication
 
conductorAgentInvoker() - Method in class io.aeron.Aeron
Get the AgentInvoker for the client conductor.
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
 
Configuration() - Constructor for class io.aeron.Aeron.Configuration
 
ConfigurationException - Exception in io.aeron.exceptions
 
ConfigurationException(String) - Constructor for exception io.aeron.exceptions.ConfigurationException
 
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
containsKey(String) - Method in class io.aeron.ChannelUri
Does the URI contain a value for the given key.
context() - Method in class io.aeron.Aeron
Get the Aeron.Context that is used by this client.
Context() - Constructor for class io.aeron.Aeron.Context
 
context() - Method in class io.aeron.logbuffer.Header
Context for storing state related to the context of the callback where the header is used.
controlEndpoint(String) - Method in class io.aeron.ChannelUriStringBuilder
Set the control address:port pair for dynamically joining a multi-destination-cast publication.
controlEndpoint() - Method in class io.aeron.ChannelUriStringBuilder
Get the control address:port pair for dynamically joining a multi-destination-cast publication.
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.
ControlledFragmentAssembler(ControlledFragmentHandler, int, boolean) - 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.
controlMode(String) - Method in class io.aeron.ChannelUriStringBuilder
Set the control mode for multi-destination-cast.
controlMode() - Method in class io.aeron.ChannelUriStringBuilder
Get the control mode for multi-destination-cast.
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
Base flyweight that can be extended to track a client request.
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.CounterUpdateFlyweight
Get the correlation id field
correlationId(long) - Method in class io.aeron.command.CounterUpdateFlyweight
Set the 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.OperationSucceededFlyweight
return correlation id field
correlationId(long) - Method in class io.aeron.command.OperationSucceededFlyweight
set correlation id field
correlationId() - Method in class io.aeron.command.PublicationBuffersReadyFlyweight
Get the correlation id field
correlationId(long) - Method in class io.aeron.command.PublicationBuffersReadyFlyweight
Set the correlation id field
correlationId() - Method in class io.aeron.command.SubscriptionReadyFlyweight
Get the correlation id field
correlationId(long) - Method in class io.aeron.command.SubscriptionReadyFlyweight
Set the 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.
Counter - Class in io.aeron
Counter stored in the counters file managed by the media driver which can be read with AeronStat.
counterId() - Method in class io.aeron.command.CounterUpdateFlyweight
The counter id.
counterId(int) - Method in class io.aeron.command.CounterUpdateFlyweight
Set counter id field
counterId() - Method in class io.aeron.status.ReadableCounter
Return the counter Id.
CounterMessageFlyweight - Class in io.aeron.command
Message to denote a new counter.
CounterMessageFlyweight() - Constructor for class io.aeron.command.CounterMessageFlyweight
 
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
Get the 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
 
CounterUpdateFlyweight - Class in io.aeron.command
Message to denote that a Counter has become available or unavailable.
CounterUpdateFlyweight() - Constructor for class io.aeron.command.CounterUpdateFlyweight
 
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
 
CredentialsSupplier - Interface in io.aeron.security
Supplier of credentials for authentication with a system.
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 Frame header of a message fragment.
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
decRef() - Method in class io.aeron.LogBuffers
 
DEFAULT_AUTHENTICATOR - Static variable in class io.aeron.security.DefaultAuthenticatorSupplier
 
DEFAULT_DRIVER_TIMEOUT_MS - Static variable in class io.aeron.CommonContext
Default timeout in which the driver is expected to respond or heartbeat.
DEFAULT_ERROR_HANDLER - Static variable in class io.aeron.Aeron.Configuration
The Default handler for Aeron runtime exceptions.
DEFAULT_RESERVE_VALUE - Static variable in class io.aeron.protocol.DataHeaderFlyweight
 
DefaultAuthenticatorSupplier - Class in io.aeron.security
Default Authenticator that authenticates all connection requests immediately.
DefaultAuthenticatorSupplier() - Constructor for class io.aeron.security.DefaultAuthenticatorSupplier
 
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.
delete() - Method in class io.aeron.LogBuffers
 
deleteAeronDirectory() - Method in class io.aeron.CommonContext
Delete the current Aeron directory, throwing errors if not possible.
DestinationMessageFlyweight - Class in io.aeron.command
Control message for adding or removing a destination for a Publication in multi-destination-cast or a Subscription in multi-destination Subscription.
DestinationMessageFlyweight() - Constructor for class io.aeron.command.DestinationMessageFlyweight
 
DirectBufferVector - Class in io.aeron
Vector into a DirectBuffer to be used for gathering IO as and offset and length.
DirectBufferVector() - Constructor for class io.aeron.DirectBufferVector
Default constructor so the fluent API can be used.
DirectBufferVector(DirectBuffer, int, int) - Constructor for class io.aeron.DirectBufferVector
Construct a new vector as a subset of a buffer.
DRIVER_TIMEOUT_MS - Static variable in class io.aeron.CommonContext
Timeout in which the driver is expected to respond or heartbeat.
DRIVER_TIMEOUT_PROP_NAME - Static variable in class io.aeron.CommonContext
Property name for driver timeout after which the driver is considered inactive.
driverAgentInvoker(AgentInvoker) - Method in class io.aeron.Aeron.Context
Set the AgentInvoker for the Media Driver to be used while awaiting a synchronous response.
driverAgentInvoker() - Method in class io.aeron.Aeron.Context
Get the AgentInvoker that is used to run the Media Driver while awaiting a synchronous response.
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, long) - 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.
duplicateTermBuffers() - Method in class io.aeron.LogBuffers
Duplicate the underlying ByteBuffers and wrap them for thread local access.

E

echoTimestampNs() - Method in class io.aeron.protocol.RttMeasurementFlyweight
 
echoTimestampNs(long) - Method in class io.aeron.protocol.RttMeasurementFlyweight
 
encodedCredentials() - Method in interface io.aeron.security.CredentialsSupplier
Provide encoded credentials to be included in Session Connect message a system.
encodedCredentials() - Method in class io.aeron.security.NullCredentialsSupplier
 
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
 
EndOfStreamHandler - Interface in io.aeron
Deprecated.
endOfStreamPosition(UnsafeBuffer) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Get the value of the end of stream position.
endOfStreamPosition(UnsafeBuffer, long) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Set the value of the end of stream position.
endpoint(String) - Method in class io.aeron.ChannelUriStringBuilder
Set the endpoint address:port pairing for the channel.
endpoint() - Method in class io.aeron.ChannelUriStringBuilder
Get the endpoint address:port pairing for the channel.
ENDPOINT_PARAM_NAME - Static variable in class io.aeron.CommonContext
The address and port used for a UDP channel.
entityTag() - Method in class io.aeron.ChannelUri
Get the entity tag, if it exists, that refers to an entity such as subscription or publication.
EOS_FLAG - Static variable in class io.aeron.protocol.DataHeaderFlyweight
End of Stream Flag
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 EpochClock 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.
errorCodeValue() - Method in class io.aeron.command.ErrorResponseFlyweight
Error code value for the command.
errorCodeValue() - Method in exception io.aeron.exceptions.RegistrationException
Value of the errorCode encoded.
ERRORED - Static variable in class io.aeron.status.ChannelEndpointStatus
Channel has errored.
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
ErrorResponseFlyweight() - Constructor for class io.aeron.command.ErrorResponseFlyweight
 
ExclusiveBufferClaim - Class in io.aeron.logbuffer
Deprecated.
ExclusiveBufferClaim() - Constructor for class io.aeron.logbuffer.ExclusiveBufferClaim
Deprecated.
 
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 tripped the end of the buffer and needs to rotate.
FAILED - Static variable in class io.aeron.logbuffer.TermAppender
The append operation failed because it was past the end of the buffer.
fileChannel() - Method in class io.aeron.Image
The FileChannel to the raw log of the Image.
fileChannel() - Method in class io.aeron.LogBuffers
The FileChannel for the mapped log.
fillMetaData(UnsafeBuffer, int, int, int, int, long, int, long, long) - Static method in class io.aeron.CncFileDescriptor
 
flags() - Method in class io.aeron.logbuffer.BufferClaim
Get the value of the flags field.
flags(byte) - Method in class io.aeron.logbuffer.BufferClaim
Set the value of the header flags field.
flags(byte) - Method in class io.aeron.logbuffer.ExclusiveBufferClaim
Deprecated.
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.
formatError(PrintStream, SimpleDateFormat, int, long, long, String) - Static method in class io.aeron.CommonContext
 
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.
FragmentAssembler(FragmentHandler, int, boolean) - 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) - Static method in class io.aeron.logbuffer.FrameDescriptor
Get the flags field for a frame.
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(String) - Method in class io.aeron.ChannelUri
Get a value for a given parameter key.
get(String, String) - Method in class io.aeron.ChannelUri
Get the value for a given parameter key or the default value provided if the key does not exist.
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
 
get() - Method in class io.aeron.security.DefaultAuthenticatorSupplier
 
get() - Method in class io.aeron.status.ReadableCounter
Get the latest value for the counter with volatile semantics.
getAeronDirectoryName() - Static method in class io.aeron.CommonContext
Get the default directory name to be used if CommonContext.aeronDirectoryName(String) is not set.
getMessage() - Method in exception io.aeron.exceptions.RegistrationException
 
getTag(String) - Static method in class io.aeron.ChannelUri
Get the value of the tag from a given parameter value.
getWeak() - Method in class io.aeron.status.ReadableCounter
Get the value of the counter using weak ordering semantics.

H

hasNoImages() - Method in class io.aeron.Subscription
Has this subscription currently no Images?
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(int, int, Object) - 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.NakFlyweight
 
HEADER_LENGTH - Static variable in class io.aeron.protocol.RttMeasurementFlyweight
 
HEADER_LENGTH - Static variable in class io.aeron.protocol.SetupFlyweight
Length of the Setup Message Frame
HEADER_LENGTH - Static variable in class io.aeron.protocol.StatusMessageFlyweight
Length of the Status Message Frame
HeaderFlyweight - Class in io.aeron.protocol
Flyweight for general Aeron network protocol header of a message frame.
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.BufferClaim
Get the value of the header type field.
headerType(int) - Method in class io.aeron.logbuffer.BufferClaim
Set the value of the header type field.
headerType(int) - Method in class io.aeron.logbuffer.ExclusiveBufferClaim
Deprecated.
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(long, long, long) - Constructor for class io.aeron.logbuffer.HeaderWriter
 
headerWriter - Variable in class io.aeron.Publication
 
HeartbeatStatus - Class in io.aeron.status
Allocate a counter for tracking the last heartbeat of an entity.
HeartbeatStatus() - Constructor for class io.aeron.status.HeartbeatStatus
 

I

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.
imageAtIndex(int) - Method in class io.aeron.Subscription
Get the Image at the given index from the images array.
ImageBuffersReadyFlyweight - Class in io.aeron.command
Message to denote that new buffers for a publication image are ready 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.
ImageControlledFragmentAssembler(ControlledFragmentHandler, int, boolean) - 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 associated 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.
ImageFragmentAssembler(FragmentHandler, int, boolean) - Constructor for class io.aeron.ImageFragmentAssembler
Construct an adapter to reassemble message fragments and delegate on only whole messages.
ImageMessageFlyweight - Class in io.aeron.command
Control message flyweight for any message that needs to represent a connection
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.
incRef() - Method in class io.aeron.LogBuffers
 
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_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.
INITIALIZING - Static variable in class io.aeron.status.ChannelEndpointStatus
Channel is being initialized.
initialPosition(long, int, int) - Method in class io.aeron.ChannelUri
Initialise a channel for restarting a publication at a given position.
initialPosition(long, int, int) - Method in class io.aeron.ChannelUriStringBuilder
Initialise a channel for restarting a publication at a given position.
initialTermId(Integer) - Method in class io.aeron.ChannelUriStringBuilder
Set the initial term id at which a publication will start.
initialTermId() - Method in class io.aeron.ChannelUriStringBuilder
the initial term id at which a publication will start.
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 - Variable in class io.aeron.Publication
 
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.
INTERFACE_PARAM_NAME - Static variable in class io.aeron.CommonContext
The network interface via which the socket will be routed.
interServiceTimeout() - Method in class io.aeron.Aeron.Context
Return the timeout between service calls to the duty cycle for the client.
INVALID_TAG - Static variable in class io.aeron.ChannelUri
 
io.aeron - package io.aeron
Aeron client that is used to communicate to a local Media Driver for the publication and subscription to message streams.
io.aeron.command - package io.aeron.command
Command message codec flyweights for the communication protocol between Aeron clients and the Media Driver.
io.aeron.exceptions - package io.aeron.exceptions
Common exception used by Aeron which are all unchecked.
io.aeron.logbuffer - package io.aeron.logbuffer
Package of classes for working with message streams encoded into the log buffers.
io.aeron.protocol - package io.aeron.protocol
Flyweight classes for encoding and decoding network protocol messages.
io.aeron.security - package io.aeron.security
Basic security infrastructure for authenticating sessions by delegating to an Authenticator.
io.aeron.status - package io.aeron.status
Counters for tracking status relevant to client activity.
IPC_CHANNEL - Static variable in class io.aeron.CommonContext
URI used for IPC Publications and Subscriptions
IPC_MEDIA - Static variable in class io.aeron.CommonContext
Media type used for IPC shared memory from Publication to Subscription channels.
isClosed() - Method in class io.aeron.Aeron
Has the client been closed? If not then the CnC file may not be unmapped.
isClosed() - Method in class io.aeron.Counter
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 - Variable in class io.aeron.Publication
 
isClosed() - Method in class io.aeron.Publication
Has this object been closed and should no longer be used?
isClosed() - Method in class io.aeron.status.ReadableCounter
Has this counters 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(UnsafeBuffer) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Get whether the log is considered connected or not by the driver.
isConnected(UnsafeBuffer, boolean) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Set whether the log is considered connected or not by the driver.
isConnected() - Method in class io.aeron.Publication
Has the Publication seen an active Subscriber recently?
isConnected() - Method in class io.aeron.Subscription
Is this subscription connected by having at least one open publication Image.
isDirectByteBuffer() - Method in class io.aeron.ControlledFragmentAssembler
Is the underlying buffer used to assemble fragments a direct ByteBuffer?
isDirectByteBuffer() - Method in class io.aeron.FragmentAssembler
Is the underlying buffer used to assemble fragments a direct ByteBuffer?
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>, ByteBuffer) - Static method in class io.aeron.CommonContext
Is a media driver active in the current mapped CnC buffer? If the driver is mid start then it will wait for up to the driverTimeoutMs by checking for the cncVersion being set.
isEndOfStream() - Method in class io.aeron.Image
Is the current consumed position at the end of the stream?
isEndOfStream(UnsafeBuffer) - Static method in class io.aeron.protocol.DataHeaderFlyweight
Does the data frame in the packet have the EOS flag set?
isHeartbeat(UnsafeBuffer, int) - Static method in class io.aeron.protocol.DataHeaderFlyweight
Is the frame at data frame at the beginning of packet a heartbeat message?
isOriginal() - Method in class io.aeron.Publication
Is this Publication the original instance added to the driver? If not then it was added after another client has already added the publication.
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?
isSessionIdTagged(boolean) - Method in class io.aeron.ChannelUriStringBuilder
Toggle the value for ChannelUriStringBuilder.sessionId() being tagged or not.
isSessionIdTagged() - Method in class io.aeron.ChannelUriStringBuilder
Is the value for ChannelUriStringBuilder.sessionId() a tagged.
isTagged(String) - Static method in class io.aeron.ChannelUri
Is the param value tagged? (starts with the "tag:" prefix)

J

joinPosition() - Method in class io.aeron.Image
Get the position the subscriber joined this stream at.

K

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.
keyBuffer(DirectBuffer, int, int) - Method in class io.aeron.command.CounterMessageFlyweight
Fill the key buffer.
keyBufferLength() - Method in class io.aeron.command.CounterMessageFlyweight
Length of the key buffer in bytes
keyBufferOffset() - Method in class io.aeron.command.CounterMessageFlyweight
Offset of the key buffer

L

label(String) - Method in class io.aeron.command.CounterMessageFlyweight
Fill the label.
label() - Method in class io.aeron.status.ReadableCounter
Return the counter label.
labelBuffer(DirectBuffer, int, int) - Method in class io.aeron.command.CounterMessageFlyweight
Fill the label buffer.
labelBufferLength() - Method in class io.aeron.command.CounterMessageFlyweight
Length of label buffer in bytes.
labelBufferOffset() - Method in class io.aeron.command.CounterMessageFlyweight
Offset of label buffer.
LENGTH - Static variable in class io.aeron.command.ClientTimeoutFlyweight
 
LENGTH - Static variable in class io.aeron.command.CorrelatedMessageFlyweight
 
length() - Method in class io.aeron.command.CounterMessageFlyweight
Get the length of the current message
LENGTH - Static variable in class io.aeron.command.CounterUpdateFlyweight
 
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
length() - Method in class io.aeron.command.ImageMessageFlyweight
Get the length of the current message
LENGTH - Static variable in class io.aeron.command.OperationSucceededFlyweight
 
length() - Method in class io.aeron.command.PublicationBuffersReadyFlyweight
Get the length of the current message
length() - Method in class io.aeron.command.PublicationMessageFlyweight
Get the length of the current message
length() - Static method in class io.aeron.command.RemoveMessageFlyweight
 
length() - Method in class io.aeron.command.SubscriptionMessageFlyweight
 
LENGTH - Static variable in class io.aeron.command.SubscriptionReadyFlyweight
 
length - Variable in class io.aeron.DirectBufferVector
 
length() - Method in class io.aeron.DirectBufferVector
Length of the vector in the buffer starting at the offset.
length(int) - Method in class io.aeron.DirectBufferVector
Length of the vector in the buffer starting at the offset.
length() - Method in class io.aeron.logbuffer.BufferClaim
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.
linger(Long) - Method in class io.aeron.ChannelUriStringBuilder
Set the time a network publication will linger in nanoseconds after being drained.
linger() - Method in class io.aeron.ChannelUriStringBuilder
Get the time a network publication will linger in nanoseconds after being drained.
LINGER_PARAM_NAME - Static variable in class io.aeron.CommonContext
Key for the linger timeout for a publication to wait around after draining in nanoseconds.
LOG_ACTIVE_TERM_COUNT_OFFSET - Static variable in class io.aeron.logbuffer.LogBufferDescriptor
Offset within the log metadata where the active partition index is stored.
LOG_CORRELATION_ID_OFFSET - Static variable in class io.aeron.logbuffer.LogBufferDescriptor
Offset within the log metadata which the correlation id is stored.
LOG_DEFAULT_FRAME_HEADER_LENGTH_OFFSET - Static variable in class io.aeron.logbuffer.LogBufferDescriptor
Offset within the log metadata 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_END_OF_STREAM_POSITION_OFFSET - Static variable in class io.aeron.logbuffer.LogBufferDescriptor
Offset within the log metadata where the position of the End of Stream is stored.
LOG_INITIAL_TERM_ID_OFFSET - Static variable in class io.aeron.logbuffer.LogBufferDescriptor
Offset within the log metadata where the active term id is stored.
LOG_IS_CONNECTED_OFFSET - Static variable in class io.aeron.logbuffer.LogBufferDescriptor
Offset within the log metadata where whether the log is connected or not is stored.
LOG_META_DATA_LENGTH - Static variable in class io.aeron.logbuffer.LogBufferDescriptor
Total length of the log metadata 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 metadata which the MTU length is stored.
LOG_PAGE_SIZE_OFFSET - Static variable in class io.aeron.logbuffer.LogBufferDescriptor
Offset within the log metadata which the page size is stored.
LOG_TERM_LENGTH_OFFSET - Static variable in class io.aeron.logbuffer.LogBufferDescriptor
Offset within the log metadata which the term length 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) - Constructor for class io.aeron.LogBuffers
Construct the log buffers for a given log file.
logBuffers - Variable in class io.aeron.Publication
 
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.
logMetaDataBuffer - Variable in class io.aeron.Publication
 

M

mapExistingCncFile(Consumer<String>) - Method in class io.aeron.CommonContext
Map the CnC file if it exists.
MAX_CHANNEL_LENGTH - Static variable in class io.aeron.status.ChannelEndpointStatus
The maximum length in bytes of the encoded channel identity.
MAX_MESSAGE_LENGTH - Static variable in class io.aeron.logbuffer.FrameDescriptor
Set a pragmatic maximum message length regardless of term length to encourage better design.
MAX_POSITION_EXCEEDED - Static variable in class io.aeron.Publication
The offer failed due to reaching the maximum position of the stream given term buffer length times the total possible number of terms.
maxMessageLength - Variable in class io.aeron.Publication
 
maxMessageLength() - Method in class io.aeron.Publication
Maximum message length supported in bytes.
maxPayloadLength - Variable in class io.aeron.Publication
 
maxPayloadLength() - Method in class io.aeron.Publication
Maximum length of a message payload that fits within a message fragment.
maxPossiblePosition - Variable in class io.aeron.Publication
 
maxPossiblePosition() - Method in class io.aeron.Publication
The maximum possible position this stream can reach due to its term buffer length.
MDC_CONTROL_MODE_DYNAMIC - Static variable in class io.aeron.CommonContext
Valid value for CommonContext.MDC_CONTROL_MODE_PARAM_NAME when dynamic control is desired.
MDC_CONTROL_MODE_MANUAL - Static variable in class io.aeron.CommonContext
Valid value for CommonContext.MDC_CONTROL_MODE_PARAM_NAME when manual control is desired.
MDC_CONTROL_MODE_PARAM_NAME - Static variable in class io.aeron.CommonContext
Key for the mode of control that such be used for multi-destination-cast semantics.
MDC_CONTROL_PARAM_NAME - Static variable in class io.aeron.CommonContext
The param for the control channel IP address and port for multi-destination-cast semantics.
media() - Method in class io.aeron.ChannelUri
The media over which the channel operates.
media(String) - Method in class io.aeron.ChannelUri
Set the media over which the channel operates.
media(String) - Method in class io.aeron.ChannelUriStringBuilder
Set the media for this channel.
media() - Method in class io.aeron.ChannelUriStringBuilder
The media over which the channel transmits.
META_DATA_LENGTH - Static variable in class io.aeron.CncFileDescriptor
 
metaDataBuffer() - Method in class io.aeron.LogBuffers
Get the buffer which holds the log metadata.
MIN_HEADER_LENGTH - Static variable in class io.aeron.protocol.HeaderFlyweight
 
mtu(Integer) - Method in class io.aeron.ChannelUriStringBuilder
Set the maximum transmission unit (MTU) including Aeron header for a datagram payload.
mtu() - Method in class io.aeron.ChannelUriStringBuilder
Get the maximum transmission unit (MTU) including Aeron header for a datagram payload.
MTU_LENGTH_PARAM_NAME - Static variable in class io.aeron.CommonContext
MTU length parameter name for using as a channel URI param.
mtuLength() - Method in class io.aeron.Image
The length in bytes of the MTU (Maximum Transmission Unit) the Sender used for the datagram.
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 Message Frame.
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.
networkInterface(String) - Method in class io.aeron.ChannelUriStringBuilder
Set the address of the local interface in the form host:[port]/[subnet mask] for routing traffic.
networkInterface() - Method in class io.aeron.ChannelUriStringBuilder
Get the address of the local interface in the form host:[port]/[subnet mask] for routing traffic.
newDefaultCncFile() - Static method in class io.aeron.CommonContext
Create a new command and control file in the administration directory.
newInstance(UnsafeBuffer) - Static method in class io.aeron.logbuffer.HeaderWriter
 
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.
NO_ID_ALLOCATED - Static variable in class io.aeron.status.ChannelEndpointStatus
No counter ID is allocated yet.
NOT_CONNECTED - Static variable in class io.aeron.Publication
The publication is not yet connected to a subscriber.
NULL_CREDENTIAL - Static variable in class io.aeron.security.NullCredentialsSupplier
 
NULL_ENCODED_PRINCIPAL - Static variable in class io.aeron.security.DefaultAuthenticatorSupplier
 
NULL_SESSION_ID - Static variable in class io.aeron.CommonContext
Value to represent a sessionId that is not to be used.
NULL_VALUE - Static variable in class io.aeron.Aeron
Used to represent a null value for when some value is not yet set.
NullCredentialsSupplier - Class in io.aeron.security
Null provider of credentials when no authentication is required.
NullCredentialsSupplier() - Constructor for class io.aeron.security.NullCredentialsSupplier
 

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, int, int, ReservedValueSupplier) - Method in class io.aeron.ConcurrentPublication
Non-blocking publish of a partial buffer containing a message.
offer(DirectBuffer, int, int, DirectBuffer, int, int, ReservedValueSupplier) - Method in class io.aeron.ConcurrentPublication
Non-blocking publish of a message composed of two parts, e.g.
offer(DirectBufferVector[], ReservedValueSupplier) - Method in class io.aeron.ConcurrentPublication
Non-blocking publish by gathering buffer vectors into 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, int, int, DirectBuffer, int, int, ReservedValueSupplier) - Method in class io.aeron.ExclusivePublication
Non-blocking publish of a message composed of two parts, e.g.
offer(DirectBufferVector[], ReservedValueSupplier) - Method in class io.aeron.ExclusivePublication
Non-blocking publish by gathering buffer vectors into 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.
offer(DirectBuffer, int, int, DirectBuffer, int, int) - Method in class io.aeron.Publication
Non-blocking publish of a message composed of two parts, e.g.
offer(DirectBuffer, int, int, DirectBuffer, int, int, ReservedValueSupplier) - Method in class io.aeron.Publication
Non-blocking publish of a message composed of two parts, e.g.
offer(DirectBufferVector[]) - Method in class io.aeron.Publication
Non-blocking publish by gathering buffer vectors into a message.
offer(DirectBufferVector[], ReservedValueSupplier) - Method in class io.aeron.Publication
Non-blocking publish by gathering buffer vectors into a message.
offset - Variable in class io.aeron.command.ClientTimeoutFlyweight
 
offset - Variable in class io.aeron.command.CorrelatedMessageFlyweight
 
offset - Variable in class io.aeron.command.OperationSucceededFlyweight
 
offset - Variable in class io.aeron.DirectBufferVector
 
offset() - Method in class io.aeron.DirectBufferVector
Offset in the buffer at which the vector starts.
offset(int) - Method in class io.aeron.DirectBufferVector
Offset in the buffer at which the vector starts.
offset() - Method in class io.aeron.logbuffer.BufferClaim
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_CLIENT_TIMEOUT - Static variable in class io.aeron.command.ControlProtocolEvents
Inform clients of client timeout.
ON_COUNTER_READY - Static variable in class io.aeron.command.ControlProtocolEvents
New counter is ready 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_SUBSCRIPTION_READY - Static variable in class io.aeron.command.ControlProtocolEvents
New Subscription is ready notification.
ON_UNAVAILABLE_COUNTER - Static variable in class io.aeron.command.ControlProtocolEvents
Inform clients of removal of counter.
ON_UNAVAILABLE_IMAGE - Static variable in class io.aeron.command.ControlProtocolEvents
Inform client of timeout and removal of an inactive Image.
onAvailableCounter(CountersReader, long, int) - Method in interface io.aeron.AvailableCounterHandler
Method called by Aeron to deliver notification of a Counter being available.
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.
onChallenge(byte[]) - Method in interface io.aeron.security.CredentialsSupplier
Given some encoded challenge, provide the credentials to be included in a Challenge Response as part of authentication with a system.
onChallenge(byte[]) - Method in class io.aeron.security.NullCredentialsSupplier
 
onChallengedSession(SessionProxy, long) - Method in interface io.aeron.security.Authenticator
Called when a challenged client should be able to accept a response from the authenticator.
onChallengeResponse(long, byte[], long) - Method in interface io.aeron.security.Authenticator
Called upon reception of a Challenge Response from an unauthenticated client.
onConnectedSession(SessionProxy, long) - Method in interface io.aeron.security.Authenticator
Called when a client's response channel has been connected.
onConnectRequest(long, byte[], long) - Method in interface io.aeron.security.Authenticator
Called upon reception of a Connect Request.
onEndOfStream(Image) - Method in interface io.aeron.EndOfStreamHandler
Deprecated.
Method called by Aeron to deliver notification that an Image has reached End of Stream.
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.
onUnavailableCounter(CountersReader, long, int) - Method in interface io.aeron.UnavailableCounterHandler
Method called by Aeron to deliver notification of counter being removed.
onUnavailableImage(Image) - Method in interface io.aeron.UnavailableImageHandler
Method called by Aeron to deliver notification that an Image is no longer available for polling.
OperationSucceededFlyweight - Class in io.aeron.command
Indicate a given operation is done and has succeeded.
OperationSucceededFlyweight() - Constructor for class io.aeron.command.OperationSucceededFlyweight
 
originalRegistrationId - Variable in class io.aeron.Publication
 
originalRegistrationId() - Method in class io.aeron.Publication
Get the registration used to register this Publication with the media driver by the first publisher.

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.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.
PAGE_MAX_SIZE - Static variable in class io.aeron.logbuffer.LogBufferDescriptor
Maximum page size
PAGE_MIN_SIZE - Static variable in class io.aeron.logbuffer.LogBufferDescriptor
Minimum page size
pageSize(UnsafeBuffer) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Get the value of the page size used for this log.
pageSize(UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Set the page size used for this log.
parse(CharSequence) - Static method in class io.aeron.ChannelUri
Parse a CharSequence which contains an Aeron URI.
PARTITION_COUNT - Static variable in class io.aeron.logbuffer.LogBufferDescriptor
The number of partitions the log is divided into.
pid(DirectBuffer) - Static method in class io.aeron.CncFileDescriptor
 
PID_FIELD_OFFSET - Static variable in class io.aeron.CncFileDescriptor
 
pidOffset(int) - Static method in class io.aeron.CncFileDescriptor
 
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.
pollEndOfStreams(EndOfStreamHandler) - Method in class io.aeron.Subscription
Deprecated.
position() - Method in class io.aeron.ExclusivePublication
 
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.
positionBitsToShift() - Method in class io.aeron.Image
Number of bits to right shift a position to get a term count for how far the stream has progressed.
positionBitsToShift(int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Get the number of bits to shift when dividing or multiplying by the term buffer length.
positionBitsToShift - Variable in class io.aeron.Publication
 
positionBitsToShift() - Method in class io.aeron.Publication
Number of bits to right shift a position to get a term count for how far the stream has progressed.
positionLimit - Variable in class io.aeron.Publication
 
positionLimit() - Method in class io.aeron.Publication
Get the position limit beyond which this Publication will be back pressured.
positionLimitId() - Method in class io.aeron.Publication
Get the counter id for the position limit after which the publication will be back pressured.
prefix() - Method in class io.aeron.ChannelUri
The prefix for the channel.
prefix(String) - Method in class io.aeron.ChannelUri
Change the prefix from what has been parsed.
prefix(String) - Method in class io.aeron.ChannelUriStringBuilder
Set the prefix for taking an addition action such as spying on an outgoing publication with "aeron-spy".
prefix() - Method in class io.aeron.ChannelUriStringBuilder
Get the prefix for the additional action to be taken on the request.
printCounters(PrintStream) - Method in class io.aeron.Aeron
Print out the values from Aeron.countersReader() which can be useful for debugging.
Publication - Class in io.aeron
Aeron publisher API for sending messages to subscribers of a given channel and streamId pair.
Publication(ClientConductor, String, int, int, ReadablePosition, int, LogBuffers, long, long) - Constructor for class io.aeron.Publication
 
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
 
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
PublicationMessageFlyweight() - Constructor for class io.aeron.command.PublicationMessageFlyweight
 
put(String, String) - Method in class io.aeron.ChannelUri
Put a key and value pair in the map of params.
putBytes(DirectBuffer, int, int) - Method in class io.aeron.logbuffer.BufferClaim
Put bytes into the claimed buffer space for a message.

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(UnsafeBuffer, int, long) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Set the raw value of the tail for the given partition.
rawTail(UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Get 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.
ReadableCounter - Class in io.aeron.status
Readonly View of an associated Counter.
ReadableCounter(CountersReader, long, int) - Constructor for class io.aeron.status.ReadableCounter
Construct a view of an existing counter.
ReadableCounter(CountersReader, int) - Constructor for class io.aeron.status.ReadableCounter
Construct a view of an existing counter.
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
Identifier for the receiver to distinguish them for FlowControl strategies.
receiverId(long) - Method in class io.aeron.protocol.StatusMessageFlyweight
Identifier for the receiver to distinguish them for FlowControl strategies.
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
 
REGISTRATION_ID_OFFSET - Static variable in class io.aeron.status.HeartbeatStatus
Offset in the key meta data for the registration id of the counter.
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(int, ErrorCode, String) - Constructor for exception io.aeron.exceptions.RegistrationException
 
registrationId() - Method in class io.aeron.command.PublicationBuffersReadyFlyweight
Get the registration id field.
registrationId(long) - Method in class io.aeron.command.PublicationBuffersReadyFlyweight
Set the correlation id field
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.Counter
Return the registration id used to register this counter with the media driver.
registrationId - Variable in class io.aeron.Publication
 
registrationId() - Method in class io.aeron.Publication
Get the registration id used to register this Publication with the media driver.
registrationId() - Method in class io.aeron.status.ReadableCounter
Return the registration Id for the counter.
registrationId() - Method in class io.aeron.Subscription
Return the registration id used to register this Subscription with the media driver.
reject() - Method in interface io.aeron.security.SessionProxy
Inform the system that the session has NOT met authentication requirements and should be rejected.
reliable(Boolean) - Method in class io.aeron.ChannelUriStringBuilder
Set the subscription semantics for if loss is acceptable, or not, for a reliable message delivery.
reliable() - Method in class io.aeron.ChannelUriStringBuilder
Get the subscription semantics for if loss is acceptable, or not, for a reliable message delivery.
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(String) - Method in class io.aeron.ChannelUri
Remove a key pair in the map of params.
REMOVE_COUNTER - Static variable in class io.aeron.command.ControlProtocolEvents
Remove a Counter from the counters manager.
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_RCV_DESTINATION - Static variable in class io.aeron.command.ControlProtocolEvents
Remove Destination for existing Subscription.
REMOVE_SUBSCRIPTION - Static variable in class io.aeron.command.ControlProtocolEvents
Remove a Subscriber.
removeCounter(long) - Method in class io.aeron.DriverProxy
 
removeDestination(long, String) - Method in class io.aeron.DriverProxy
 
removeDestination(String) - Method in class io.aeron.Publication
Remove a previously added destination manually from a multi-destination-cast Publication.
removeDestination(String) - Method in class io.aeron.Subscription
Remove a previously added destination from a multi-destination Subscription.
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
 
removeRcvDestination(long, String) - 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(long) - Method in class io.aeron.logbuffer.ExclusiveBufferClaim
Deprecated.
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.
reset(DirectBuffer, int, int) - Method in class io.aeron.DirectBufferVector
Reset the values.
RESOURCE_LINGER_DURATION_DEFAULT - Static variable in class io.aeron.Aeron.Configuration
Default duration a resource should linger before deletion.
RESOURCE_LINGER_DURATION_PROP_NAME - Static variable in class io.aeron.Aeron.Configuration
Duration to wait while lingering a entity such as an Image before deleting underlying resources such as memory mapped files.
resourceLingerDurationNs() - Static method in class io.aeron.Aeron.Configuration
Duration to wait while lingering a entity such as an Image before deleting underlying resources such as memory mapped files.
resourceLingerDurationNs(long) - Method in class io.aeron.Aeron.Context
Duration to wait while lingering a entity such as an Image before deleting underlying resources such as memory mapped files.
resourceLingerDurationNs() - Method in class io.aeron.Aeron.Context
Duration to wait while lingering a entity such as an Image before deleting underlying resources such as memory mapped files.
rotateLog(UnsafeBuffer, int, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Rotate the log and update the tail counter for the new term.
RttMeasurementFlyweight - Class in io.aeron.protocol
Flyweight for an RTT Measurement Frame 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, ByteBuffer) - 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 message fragments from an offset up to a limitOffset.
scanForAvailability(UnsafeBuffer, int, int) - Static method in class io.aeron.logbuffer.TermScanner
Scan the term buffer for availability of new message fragments 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.
scheme() - Method in class io.aeron.ChannelUri
The scheme for the URI.
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
 
SESSION_ID_PARAM_NAME - Static variable in class io.aeron.CommonContext
Key for the session id for a publication or restricted subscription.
sessionId(Integer) - Method in class io.aeron.ChannelUriStringBuilder
Set the session id for a publication or restricted subscription.
sessionId() - Method in class io.aeron.ChannelUriStringBuilder
Get the session id for a publication or restricted subscription.
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
Get the session id field
sessionId(int) - Method in class io.aeron.command.PublicationBuffersReadyFlyweight
Set the session id field
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 - Variable in class io.aeron.logbuffer.HeaderWriter
 
sessionId() - Method in class io.aeron.protocol.DataHeaderFlyweight
return session id field
sessionId(UnsafeBuffer, int) - Static method in class io.aeron.protocol.DataHeaderFlyweight
 
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 - Variable in class io.aeron.Publication
 
sessionId() - Method in class io.aeron.Publication
Session under which messages are published.
sessionId() - Method in interface io.aeron.security.SessionProxy
The session Id of the potential session assigned by the system.
SessionProxy - Interface in io.aeron.security
Representation for a session which is going through the authentication process.
SetupFlyweight - Class in io.aeron.protocol
HeaderFlyweight for Setup Message Frames.
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
 
signalCncReady(UnsafeBuffer) - Static method in class io.aeron.CncFileDescriptor
 
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.
sparse(Boolean) - Method in class io.aeron.ChannelUriStringBuilder
Set to indicate if a term log buffer should be sparse on disk or not.
sparse() - Method in class io.aeron.ChannelUriStringBuilder
Get if a term log buffer should be sparse on disk or not.
SPARSE_PARAM_NAME - Static variable in class io.aeron.CommonContext
Parameter name for channel URI param to indicate if term buffers should be sparse.
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.
SPY_QUALIFIER - Static variable in class io.aeron.ChannelUri
Qualifier for spy subscriptions which spy on outgoing network destined traffic efficiently.
START_TIMESTAMP_FIELD_OFFSET - Static variable in class io.aeron.CncFileDescriptor
 
startTimestamp(DirectBuffer) - Static method in class io.aeron.CncFileDescriptor
 
startTimestampOffset(int) - Static method in class io.aeron.CncFileDescriptor
 
state() - Method in class io.aeron.status.ReadableCounter
Return the state of the counter.
status(long) - Static method in class io.aeron.status.ChannelEndpointStatus
String representation of the channel status.
statusIndicatorId() - Method in exception io.aeron.exceptions.ChannelEndpointException
Return the id for the counter associated with the channel endpoint.
StatusMessageFlyweight - Class in io.aeron.protocol
Flyweight for a Status Message Frame.
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
Get the stream id field
streamId(int) - Method in class io.aeron.command.PublicationBuffersReadyFlyweight
Set the 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.logbuffer.Header
The stream ID to which the frame belongs.
streamId - Variable in class io.aeron.logbuffer.HeaderWriter
 
streamId() - Method in class io.aeron.protocol.DataHeaderFlyweight
return stream id field
streamId(UnsafeBuffer, int) - Static method in class io.aeron.protocol.DataHeaderFlyweight
 
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 - Variable in class io.aeron.Publication
 
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.
subscriberPositionId(int) - Method in class io.aeron.command.ImageBuffersReadyFlyweight
Set the position Id for the subscriber
subscriberPositionId() - Method in class io.aeron.command.ImageBuffersReadyFlyweight
Return the position Id for the subscriber
subscriberPositionId() - Method in class io.aeron.Image
The counter id for the subscriber position counter.
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
 
SubscriptionReadyFlyweight - Class in io.aeron.command
Message to denote that a Subscription has been successfully set up.
SubscriptionReadyFlyweight() - Constructor for class io.aeron.command.SubscriptionReadyFlyweight
 
subscriptionRegistrationId(long) - Method in class io.aeron.command.ImageBuffersReadyFlyweight
Set the registration Id for the Subscription
subscriptionRegistrationId() - Method in class io.aeron.command.ImageBuffersReadyFlyweight
Return the registration Id for the Subscription
subscriptionRegistrationId() - Method in class io.aeron.command.ImageMessageFlyweight
Registration ID for the subscription.
subscriptionRegistrationId(long) - Method in class io.aeron.command.ImageMessageFlyweight
Set the tegistration ID for the subscription.

T

TAG_PREFIX - Static variable in class io.aeron.ChannelUriStringBuilder
 
TAG_PREFIX - Static variable in class io.aeron.CommonContext
Qualifier for a value which is a tag for reference.
tags(String) - Method in class io.aeron.ChannelUriStringBuilder
Set the tags for a channel used by a publication or subscription.
tags() - Method in class io.aeron.ChannelUriStringBuilder
Get the tags for a channel used by a publication or subscription.
TAGS_PARAM_NAME - Static variable in class io.aeron.CommonContext
Key for the tags for a channel
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_MAX_LENGTH - Static variable in class io.aeron.logbuffer.LogBufferDescriptor
Maximum buffer length for a log term
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 metadata 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 message fragments including padding.
TermBlockScanner() - Constructor for class io.aeron.logbuffer.TermBlockScanner
 
termBufferLength() - Method in class io.aeron.Image
Get the length in bytes for each term partition in the log buffer.
termBufferLength - Variable in class io.aeron.Publication
 
termBufferLength() - Method in class io.aeron.Publication
Get the length in bytes for each term partition in the log buffer.
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(Integer) - Method in class io.aeron.ChannelUriStringBuilder
Set the current term id at which a publication will start.
termId() - Method in class io.aeron.ChannelUriStringBuilder
Get the current term id at which a publication will start.
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() - Method in class io.aeron.protocol.DataHeaderFlyweight
return term id field
termId(UnsafeBuffer, int) - Static method in class io.aeron.protocol.DataHeaderFlyweight
 
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(Integer) - Method in class io.aeron.ChannelUriStringBuilder
Set the length of buffer used for each term of the log.
termLength() - Method in class io.aeron.ChannelUriStringBuilder
Get the length of buffer used for each term of the log.
termLength(UnsafeBuffer) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Get the value of the Term Length used for this log.
termLength(UnsafeBuffer, int) - Static method in class io.aeron.logbuffer.LogBufferDescriptor
Set the term length used for this log.
termLength() - Method in class io.aeron.LogBuffers
The length of the term buffer in each log partition.
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(Integer) - Method in class io.aeron.ChannelUriStringBuilder
Set the offset within a term at which a publication will start.
termOffset() - Method in class io.aeron.ChannelUriStringBuilder
Get the offset within a term at which a publication will start.
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.LogBufferDescriptor
The termOffset as a result of the append
termOffset() - Method in class io.aeron.protocol.DataHeaderFlyweight
return term offset field
termOffset(UnsafeBuffer, int) - Static method in class io.aeron.protocol.DataHeaderFlyweight
 
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
Utility functions for reading a term within a log buffer.
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 message fragments.
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
timeOfLastDriverKeepaliveMs() - Method in class io.aeron.DriverProxy
 
timeOfLastStateChange(long) - Method in class io.aeron.LogBuffers
 
timeOfLastStateChange() - Method in class io.aeron.LogBuffers
 
TimeoutException - Exception in io.aeron.exceptions
Generic timeout has occurred while waiting on some action or event.
TimeoutException() - Constructor for exception io.aeron.exceptions.TimeoutException
 
TimeoutException(String) - Constructor for exception io.aeron.exceptions.TimeoutException
 
TimeoutException(String, Throwable) - Constructor for exception io.aeron.exceptions.TimeoutException
 
TimeoutException(Throwable) - Constructor for exception io.aeron.exceptions.TimeoutException
 
TimeoutException(String, Throwable, boolean, boolean) - Constructor for exception io.aeron.exceptions.TimeoutException
 
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() - 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() - 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.ChannelUri
Generate a String representation of the URI that is valid for an Aeron channel.
toString() - Method in class io.aeron.DirectBufferVector
 
toString() - Method in class io.aeron.Image
 
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
 
toString() - Method in class io.aeron.Publication
 
toString() - Method in class io.aeron.Subscription
 
tryClaim(int, BufferClaim) - Method in class io.aeron.ConcurrentPublication
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.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(Integer) - Method in class io.aeron.ChannelUriStringBuilder
Set the Time To Live (TTL) for a multicast datagram.
ttl() - Method in class io.aeron.ChannelUriStringBuilder
Get the Time To Live (TTL) for a multicast datagram.
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
TTL_PARAM_NAME - Static variable in class io.aeron.CommonContext
Time To Live param for a multicast datagram.
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
typeId() - Method in class io.aeron.command.CounterMessageFlyweight
return type id field
typeId(long) - Method in class io.aeron.command.CounterMessageFlyweight
set counter type id field
typeOffset(int) - Static method in class io.aeron.logbuffer.FrameDescriptor
The buffer offset at which the type field begins.

U

UDP_MEDIA - Static variable in class io.aeron.CommonContext
Media type used for UDP sockets from Publication to Subscription channels.
unavailableCounterHandler(UnavailableCounterHandler) - Method in class io.aeron.Aeron.Context
Setup a callback for when a counter is unavailable.
unavailableCounterHandler() - Method in class io.aeron.Aeron.Context
Get the callback handler for when a counter is unavailable.
UnavailableCounterHandler - Interface in io.aeron
Interface for notification of Counters being removed via an Aeron client.
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, int) - 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.
useConductorAgentInvoker(boolean) - Method in class io.aeron.Aeron.Context
Should an AgentInvoker be used for running the ClientConductor rather than run it on a thread with a AgentRunner.
useConductorAgentInvoker() - Method in class io.aeron.Aeron.Context
Should an AgentInvoker be used for running the ClientConductor rather than run it on a thread with a AgentRunner.

V

validate() - Method in class io.aeron.ChannelUriStringBuilder
Validates that the collection of set parameters are valid together.
validate() - Method in class io.aeron.DirectBufferVector
Ensure the vector is valid for the buffer.
validateAndComputeLength(DirectBufferVector[]) - Static method in class io.aeron.DirectBufferVector
Validate an array of vectors to make up a message and compute the total length.
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
versionFlagsType - Variable in class io.aeron.logbuffer.HeaderWriter
 
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.ClientTimeoutFlyweight
Wrap the buffer at a given offset for updates.
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.CounterUpdateFlyweight
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.OperationSucceededFlyweight
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(MutableDirectBuffer, int) - Method in class io.aeron.command.SubscriptionReadyFlyweight
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.
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 J K L M N O P R S T U V W 
Skip navigation links

Copyright © 2014-2019 Real Logic Ltd. All Rights Reserved.