Uses of Interface
org.agrona.DirectBuffer

Packages that use DirectBuffer

Package	Description
org.agrona	Data structures and utilities useful for building high-performance Java applications.
org.agrona.agent	Java agent for instrumenting DirectBuffer implementations to verify aligned access.
org.agrona.concurrent	Concurrent data structures and utilities that support both on and off Java heap usage.
org.agrona.concurrent.broadcast	Data structure for broadcasting messages from one source to many receivers via shared memory.
org.agrona.concurrent.ringbuffer	IPC ring buffers for messaging via shared memory.
org.agrona.concurrent.status	Counters for indicating status and telemetry which can be put in shared memory for live inspection.
org.agrona.io	Bridging classes for allowing direct buffers implementations of DirectBuffer and MutableDirectBuffer to be used with Java IO streams.
org.agrona.sbe	Common interfaces which can apply to SBE messages to support abstract usage.

Uses of DirectBuffer in org.agrona

Subinterfaces of DirectBuffer in org.agrona

Modifier and Type	Interface	Description
interface	MutableDirectBuffer	Abstraction over a range of buffer types that allows fields to be written in native typed fashion.

Classes in org.agrona that implement DirectBuffer

Modifier and Type	Class	Description
class	AbstractMutableDirectBuffer	Common base class for implementing MutableDirectBuffer interface.
class	ExpandableArrayBuffer	Expandable MutableDirectBuffer that is backed by an array.
class	ExpandableDirectByteBuffer	Expandable MutableDirectBuffer that is backed by a direct ByteBuffer.

Subinterfaces with type arguments of type DirectBuffer in org.agrona

Modifier and Type	Interface	Description
interface	DirectBuffer	Abstraction over a range of buffer types that allows fields to be read in native typed fashion.

Fields in org.agrona declared as DirectBuffer

Modifier and Type	Field	Description
private DirectBuffer	AsciiSequenceView.buffer

Methods in org.agrona that return DirectBuffer

Modifier and Type	Method	Description
DirectBuffer	AsciiSequenceView.buffer()	Gets the underlying buffer which this is a view over.

Methods in org.agrona with parameters of type DirectBuffer

Modifier and Type	Method	Description
boolean	ExpandableRingBuffer.append(DirectBuffer srcBuffer, int srcOffset, int srcLength)	Append a message into the ring buffer, expanding the buffer if required.
static void	PrintBufferUtil.appendPrettyHexDump(StringBuilder dump, DirectBuffer buffer)	Appends the prettified multi-line hexadecimal dump of the specified DirectBuffer to the specified StringBuilder that is easy to read by humans.
static void	PrintBufferUtil.appendPrettyHexDump(StringBuilder dump, DirectBuffer buffer, int offset, int length)	Appends the prettified multi-line hexadecimal dump of the specified DirectBuffer to the specified StringBuilder that is easy to read by humans, starting at the given offset using the given length.
(package private) static void	PrintBufferUtil.HexUtil.appendPrettyHexDump(StringBuilder dump, DirectBuffer buffer, int offset, int length)
int	AbstractMutableDirectBuffer.compareTo(DirectBuffer that)
static void	BufferUtil.free(DirectBuffer buffer)	Free the underlying direct ByteBuffer by invoking Cleaner on it.
(package private) static short	PrintBufferUtil.HexUtil.getUnsignedByte(DirectBuffer buffer, int index)	Gets an unsigned byte at the specified absolute index in a buffer.
static String	PrintBufferUtil.hexDump(DirectBuffer buffer)	Returns a hex dump of the specified buffer's readable bytes.
static String	PrintBufferUtil.hexDump(DirectBuffer buffer, int fromIndex, int length)	Returns a hex dump of the specified buffer's subregion.
(package private) static String	PrintBufferUtil.HexUtil.hexDump(DirectBuffer buffer, int fromIndex, int length)
(package private) static String	PrintBufferUtil.HexUtil.prettyHexDump(DirectBuffer buffer, int offset, int length)
static String	PrintBufferUtil.prettyHexDump(DirectBuffer buffer)	Returns a hexadecimal dump of the specified DirectBuffer that is easy to read by humans.
static String	PrintBufferUtil.prettyHexDump(DirectBuffer buffer, int offset, int length)	Returns a hexadecimal dump of the specified DirectBuffer that is easy to read by humans, starting at the given offset using the given length.
void	AbstractMutableDirectBuffer.putBytes(int index, DirectBuffer srcBuffer, int srcIndex, int length)	Put bytes from a source DirectBuffer into this MutableDirectBuffer at given indices.
void	MutableDirectBuffer.putBytes(int index, DirectBuffer srcBuffer, int srcIndex, int length)	Put bytes from a source DirectBuffer into this MutableDirectBuffer at given indices.
AsciiSequenceView	AsciiSequenceView.wrap(DirectBuffer buffer, int offset, int length)	Wrap a range of an existing buffer containing an ASCII sequence.
void	DirectBuffer.wrap(DirectBuffer buffer)	Attach a view to an existing DirectBuffer.
void	DirectBuffer.wrap(DirectBuffer buffer, int offset, int length)	Attach a view to a DirectBuffer for providing direct access.
void	ExpandableArrayBuffer.wrap(DirectBuffer buffer)	Attach a view to an existing DirectBuffer.
void	ExpandableArrayBuffer.wrap(DirectBuffer buffer, int offset, int length)	Attach a view to a DirectBuffer for providing direct access.
void	ExpandableDirectByteBuffer.wrap(DirectBuffer buffer)	Attach a view to an existing DirectBuffer.
void	ExpandableDirectByteBuffer.wrap(DirectBuffer buffer, int offset, int length)	Attach a view to a DirectBuffer for providing direct access.
private void	ExpandableRingBuffer.writeMessage(DirectBuffer srcBuffer, int srcOffset, int srcLength)

Constructors in org.agrona with parameters of type DirectBuffer

Modifier	Constructor	Description
	AsciiSequenceView(DirectBuffer buffer, int offset, int length)	Construct a view over a DirectBuffer from an offset for a given length.

Uses of DirectBuffer in org.agrona.agent

Methods in org.agrona.agent with parameters of type DirectBuffer

Modifier and Type	Method	Description
static void	BufferAlignmentInterceptor.CharVerifier.verifyAlignment(int index, DirectBuffer buffer)	Verify alignment of the char types.
static void	BufferAlignmentInterceptor.DoubleVerifier.verifyAlignment(int index, DirectBuffer buffer)	Verify alignment of the double types.
static void	BufferAlignmentInterceptor.FloatVerifier.verifyAlignment(int index, DirectBuffer buffer)	Verify alignment of the float types.
static void	BufferAlignmentInterceptor.IntVerifier.verifyAlignment(int index, DirectBuffer buffer)	Verify alignment of the int types.
static void	BufferAlignmentInterceptor.LongVerifier.verifyAlignment(int index, DirectBuffer buffer)	Verify alignment of the long types.
static void	BufferAlignmentInterceptor.ShortVerifier.verifyAlignment(int index, DirectBuffer buffer)	Verify alignment of the short types.

Uses of DirectBuffer in org.agrona.concurrent

Subinterfaces of DirectBuffer in org.agrona.concurrent

Modifier and Type	Interface	Description
interface	AtomicBuffer	Abstraction over a range of buffer types that allows type to be accessed with various memory ordering semantics.

Classes in org.agrona.concurrent that implement DirectBuffer

Modifier and Type	Class	Description
class	UnsafeBuffer	Supports regular, byte ordered, and atomic (memory ordered) access to an underlying buffer.

Methods in org.agrona.concurrent with parameters of type DirectBuffer

Modifier and Type	Method	Description
void	UnsafeBuffer.wrap(DirectBuffer buffer)	Attach a view to an existing DirectBuffer.
void	UnsafeBuffer.wrap(DirectBuffer buffer, int offset, int length)	Attach a view to a DirectBuffer for providing direct access.

Constructors in org.agrona.concurrent with parameters of type DirectBuffer

Modifier	Constructor	Description
	UnsafeBuffer(DirectBuffer buffer)	Attach a view to an existing DirectBuffer.
	UnsafeBuffer(DirectBuffer buffer, int offset, int length)	Attach a view to an existing DirectBuffer.

Uses of DirectBuffer in org.agrona.concurrent.broadcast

Methods in org.agrona.concurrent.broadcast with parameters of type DirectBuffer

Modifier and Type	Method	Description
void	BroadcastTransmitter.transmit(int msgTypeId, DirectBuffer srcBuffer, int srcIndex, int length)	Transmit a message to BroadcastReceivers via the broadcast buffer.

Uses of DirectBuffer in org.agrona.concurrent.ringbuffer

Methods in org.agrona.concurrent.ringbuffer with parameters of type DirectBuffer

Modifier and Type	Method	Description
boolean	ManyToOneRingBuffer.write(int msgTypeId, DirectBuffer srcBuffer, int offset, int length)	Non-blocking write of a message to an underlying ring-buffer.
boolean	OneToOneRingBuffer.write(int msgTypeId, DirectBuffer srcBuffer, int offset, int length)	Non-blocking write of a message to an underlying ring-buffer.
boolean	RingBuffer.write(int msgTypeId, DirectBuffer srcBuffer, int offset, int length)	Non-blocking write of a message to an underlying ring-buffer.

Uses of DirectBuffer in org.agrona.concurrent.status

Methods in org.agrona.concurrent.status with parameters of type DirectBuffer

Modifier and Type	Method	Description
void	CountersReader.MetaData.accept(int counterId, int typeId, DirectBuffer keyBuffer, String label)	Accept a metadata record.
int	ConcurrentCountersManager.allocate(int typeId, DirectBuffer keyBuffer, int keyOffset, int keyLength, DirectBuffer labelBuffer, int labelOffset, int labelLength)	Allocate a counter with the minimum of allocation by allowing the label a key to be provided and copied.
int	CountersManager.allocate(int typeId, DirectBuffer keyBuffer, int keyOffset, int keyLength, DirectBuffer labelBuffer, int labelOffset, int labelLength)	Allocate a counter with the minimum of allocation by allowing the label a key to be provided and copied.
AtomicCounter	CountersManager.newCounter(int typeId, DirectBuffer keyBuffer, int keyOffset, int keyLength, DirectBuffer labelBuffer, int labelOffset, int labelLength)	Allocate a counter record and wrap it with a new AtomicCounter for use.
void	ConcurrentCountersManager.setCounterKey(int counterId, DirectBuffer keyBuffer, int offset, int length)	Set an AtomicCounter key by on counter id, copying the key metadata from the supplied buffer.
void	CountersManager.setCounterKey(int counterId, DirectBuffer keyBuffer, int offset, int length)	Set an AtomicCounter key by on counter id, copying the key metadata from the supplied buffer.
void	AtomicCounter.updateKey(DirectBuffer keyBuffer, int offset, int length)	Update the key for a counter constructed with a CountersManager.

Uses of DirectBuffer in org.agrona.io

Fields in org.agrona.io declared as DirectBuffer

Modifier and Type	Field	Description
private DirectBuffer	DirectBufferDataInput.buffer
private DirectBuffer	DirectBufferInputStream.buffer

Methods in org.agrona.io that return DirectBuffer

Modifier and Type	Method	Description
DirectBuffer	DirectBufferInputStream.buffer()	The underlying buffer being wrapped.

Methods in org.agrona.io with parameters of type DirectBuffer

Modifier and Type	Method	Description
void	DirectBufferDataInput.wrap(DirectBuffer buffer)	Wrap given DirectBuffer.
void	DirectBufferDataInput.wrap(DirectBuffer buffer, int offset, int length)	Wrap given DirectBuffer.
void	DirectBufferInputStream.wrap(DirectBuffer buffer)	Wrap given DirectBuffer.
void	DirectBufferInputStream.wrap(DirectBuffer buffer, int offset, int length)	Wrap given DirectBuffer.

Constructors in org.agrona.io with parameters of type DirectBuffer

Modifier	Constructor	Description
	DirectBufferDataInput(DirectBuffer buffer)	Wrap given DirectBuffer.
	DirectBufferDataInput(DirectBuffer buffer, int offset, int length)	Wrap given DirectBuffer.
	DirectBufferInputStream(DirectBuffer buffer)	Wrap given DirectBuffer.
	DirectBufferInputStream(DirectBuffer buffer, int offset, int length)	Wrap given DirectBuffer.

Uses of DirectBuffer in org.agrona.sbe

Methods in org.agrona.sbe that return DirectBuffer

Modifier and Type	Method	Description
DirectBuffer	Flyweight.buffer()	Buffer in which the flyweight is encoded.

Methods in org.agrona.sbe with parameters of type DirectBuffer

Modifier and Type	Method	Description
CompositeDecoderFlyweight	CompositeDecoderFlyweight.wrap(DirectBuffer buffer, int offset)	Wrap a buffer for decoding at a given offset.
MessageDecoderFlyweight	MessageDecoderFlyweight.wrap(DirectBuffer buffer, int offset, int actingBlockLength, int actingVersion)	Wrap a buffer containing an encoded message for decoding.