Uses of Interface
org.agrona.DirectBuffer
Packages that use DirectBuffer
Package
Description
Data structures and utilities useful for building high-performance Java applications.
Java agent for instrumenting
DirectBuffer
implementations to verify aligned access.Concurrent data structures and utilities that support both on and off Java heap usage.
Data structure for broadcasting messages from one source to many receivers via shared memory.
IPC ring buffers for messaging via shared memory.
Counters for indicating status and telemetry which can be put in shared memory for live inspection.
Bridging classes for allowing direct buffers implementations of
DirectBuffer
and
MutableDirectBuffer
to be used with Java IO streams.Common interfaces which can apply to SBE messages to support abstract usage.
-
Uses of DirectBuffer in org.agrona
Subinterfaces of DirectBuffer in org.agronaModifier and TypeInterfaceDescriptioninterface
Abstraction over a range of buffer types that allows fields to be written in native typed fashion.Classes in org.agrona that implement DirectBufferModifier and TypeClassDescriptionclass
Common base class for implementingMutableDirectBuffer
interface.class
ExpandableMutableDirectBuffer
that is backed by an array.class
ExpandableMutableDirectBuffer
that is backed by a directByteBuffer
.Fields in org.agrona declared as DirectBufferMethods in org.agrona that return DirectBufferModifier and TypeMethodDescriptionAsciiSequenceView.buffer()
Gets the underlying buffer which this is a view over.Methods in org.agrona with parameters of type DirectBufferModifier and TypeMethodDescriptionboolean
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 specifiedDirectBuffer
to the specifiedStringBuilder
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 specifiedDirectBuffer
to the specifiedStringBuilder
that is easy to read by humans, starting at the givenoffset
using the givenlength
.(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 directByteBuffer
by invokingCleaner
on it.(package private) static short
PrintBufferUtil.HexUtil.getUnsignedByte
(DirectBuffer buffer, int index) Gets an unsigned byte at the specified absoluteindex
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 specifiedDirectBuffer
that is easy to read by humans.static String
PrintBufferUtil.prettyHexDump
(DirectBuffer buffer, int offset, int length) Returns a hexadecimal dump of the specifiedDirectBuffer
that is easy to read by humans, starting at the givenoffset
using the givenlength
.void
AbstractMutableDirectBuffer.putBytes
(int index, DirectBuffer srcBuffer, int srcIndex, int length) Put bytes from a sourceDirectBuffer
into thisMutableDirectBuffer
at given indices.void
MutableDirectBuffer.putBytes
(int index, DirectBuffer srcBuffer, int srcIndex, int length) Put bytes from a sourceDirectBuffer
into thisMutableDirectBuffer
at given indices.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 existingDirectBuffer
.void
DirectBuffer.wrap
(DirectBuffer buffer, int offset, int length) Attach a view to aDirectBuffer
for providing direct access.void
ExpandableArrayBuffer.wrap
(DirectBuffer buffer) Attach a view to an existingDirectBuffer
.void
ExpandableArrayBuffer.wrap
(DirectBuffer buffer, int offset, int length) Attach a view to aDirectBuffer
for providing direct access.void
ExpandableDirectByteBuffer.wrap
(DirectBuffer buffer) Attach a view to an existingDirectBuffer
.void
ExpandableDirectByteBuffer.wrap
(DirectBuffer buffer, int offset, int length) Attach a view to aDirectBuffer
for providing direct access.private void
ExpandableRingBuffer.writeMessage
(DirectBuffer srcBuffer, int srcOffset, int srcLength) Constructors in org.agrona with parameters of type DirectBufferModifierConstructorDescriptionAsciiSequenceView
(DirectBuffer buffer, int offset, int length) Construct a view over aDirectBuffer
from an offset for a given length. -
Uses of DirectBuffer in org.agrona.agent
Methods in org.agrona.agent with parameters of type DirectBufferModifier and TypeMethodDescriptionstatic void
BufferAlignmentInterceptor.CharVerifier.verifyAlignment
(int index, DirectBuffer buffer) Verify alignment of thechar
types.static void
BufferAlignmentInterceptor.DoubleVerifier.verifyAlignment
(int index, DirectBuffer buffer) Verify alignment of thedouble
types.static void
BufferAlignmentInterceptor.FloatVerifier.verifyAlignment
(int index, DirectBuffer buffer) Verify alignment of thefloat
types.static void
BufferAlignmentInterceptor.IntVerifier.verifyAlignment
(int index, DirectBuffer buffer) Verify alignment of theint
types.static void
BufferAlignmentInterceptor.LongVerifier.verifyAlignment
(int index, DirectBuffer buffer) Verify alignment of thelong
types.static void
BufferAlignmentInterceptor.ShortVerifier.verifyAlignment
(int index, DirectBuffer buffer) Verify alignment of theshort
types. -
Uses of DirectBuffer in org.agrona.concurrent
Subinterfaces of DirectBuffer in org.agrona.concurrentModifier and TypeInterfaceDescriptioninterface
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 DirectBufferModifier and TypeClassDescriptionclass
Supports regular, byte ordered, and atomic (memory ordered) access to an underlying buffer.Methods in org.agrona.concurrent with parameters of type DirectBufferModifier and TypeMethodDescriptionvoid
UnsafeBuffer.wrap
(DirectBuffer buffer) Attach a view to an existingDirectBuffer
.void
UnsafeBuffer.wrap
(DirectBuffer buffer, int offset, int length) Attach a view to aDirectBuffer
for providing direct access.Constructors in org.agrona.concurrent with parameters of type DirectBufferModifierConstructorDescriptionUnsafeBuffer
(DirectBuffer buffer) Attach a view to an existingDirectBuffer
.UnsafeBuffer
(DirectBuffer buffer, int offset, int length) Attach a view to an existingDirectBuffer
. -
Uses of DirectBuffer in org.agrona.concurrent.broadcast
Methods in org.agrona.concurrent.broadcast with parameters of type DirectBufferModifier and TypeMethodDescriptionvoid
BroadcastTransmitter.transmit
(int msgTypeId, DirectBuffer srcBuffer, int srcIndex, int length) Transmit a message toBroadcastReceiver
s via the broadcast buffer. -
Uses of DirectBuffer in org.agrona.concurrent.ringbuffer
Methods in org.agrona.concurrent.ringbuffer with parameters of type DirectBufferModifier and TypeMethodDescriptionboolean
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 DirectBufferModifier and TypeMethodDescriptionvoid
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.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 newAtomicCounter
for use.void
ConcurrentCountersManager.setCounterKey
(int counterId, DirectBuffer keyBuffer, int offset, int length) Set anAtomicCounter
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 anAtomicCounter
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 aCountersManager
. -
Uses of DirectBuffer in org.agrona.io
Fields in org.agrona.io declared as DirectBufferModifier and TypeFieldDescriptionprivate DirectBuffer
DirectBufferDataInput.buffer
private DirectBuffer
DirectBufferInputStream.buffer
Methods in org.agrona.io that return DirectBufferModifier and TypeMethodDescriptionDirectBufferInputStream.buffer()
The underlying buffer being wrapped.Methods in org.agrona.io with parameters of type DirectBufferModifier and TypeMethodDescriptionvoid
DirectBufferDataInput.wrap
(DirectBuffer buffer) Wrap givenDirectBuffer
.void
DirectBufferDataInput.wrap
(DirectBuffer buffer, int offset, int length) Wrap givenDirectBuffer
.void
DirectBufferInputStream.wrap
(DirectBuffer buffer) Wrap givenDirectBuffer
.void
DirectBufferInputStream.wrap
(DirectBuffer buffer, int offset, int length) Wrap givenDirectBuffer
.Constructors in org.agrona.io with parameters of type DirectBufferModifierConstructorDescriptionDirectBufferDataInput
(DirectBuffer buffer) Wrap givenDirectBuffer
.DirectBufferDataInput
(DirectBuffer buffer, int offset, int length) Wrap givenDirectBuffer
.DirectBufferInputStream
(DirectBuffer buffer) Wrap givenDirectBuffer
.DirectBufferInputStream
(DirectBuffer buffer, int offset, int length) Wrap givenDirectBuffer
. -
Uses of DirectBuffer in org.agrona.sbe
Methods in org.agrona.sbe that return DirectBufferMethods in org.agrona.sbe with parameters of type DirectBufferModifier and TypeMethodDescriptionCompositeDecoderFlyweight.wrap
(DirectBuffer buffer, int offset) Wrap a buffer for decoding at a given offset.MessageDecoderFlyweight.wrap
(DirectBuffer buffer, int offset, int actingBlockLength, int actingVersion) Wrap a buffer containing an encoded message for decoding.