Package net.openhft.chronicle.bytes

Interface Summary

Interface	Description
BinaryWireCode	Defines byte codes used by Chronicle's binary wire protocol.
Byteable	Allows a Java object to view a slice of a BytesStore.
Bytes<U>	Mutable buffer for raw byte data with separate 63-bit read and write cursors.
BytesConsumer	Consumes bytes from a source and writes them to a BytesOut instance.
BytesContext	Holds a Bytes buffer and optional key for a unit of work.
BytesIn<U>	Reads data from a byte stream or buffer.
BytesMarshallable	Serialisable object that reads and writes its state directly to a Bytes stream.
BytesMethodWriterInvocationHandler	An InvocationHandler for method writers operating on BytesOut.
BytesOut<U>	Output interface for writing to a Bytes buffer.
BytesParselet	Parses messages read from a BytesIn when no specific method handler is available.
BytesPrepender<B extends BytesPrepender<B>>	Supports writing data before the current RandomCommon.readPosition().
BytesRingBuffer	Represents a ring buffer for Bytes data, intended for high-throughput, low-latency messaging between threads or services.
BytesRingBufferStats	This interface provides statistics about a BytesRingBuffer.
BytesStore<B extends BytesStore<B,U>,U>	Reference to a fixed-capacity region of memory.
ByteStringAppender<B extends ByteStringAppender<B>>	Extension of StreamingDataOutput and Appendable that exposes convenience methods for writing text and numbers to a Bytes stream.
ByteStringParser<B extends ByteStringParser<B>>	Extends StreamingDataInput with helpers for parsing textual data directly from a Bytes stream.
CommonMarshallable	Marker for objects that can be serialised to bytes.
DistributedUniqueTimeDeduplicator	Detects and optionally retains the newest timestamp for each host id so duplicates can be filtered.
DynamicallySized	Marker for Byteable objects whose encoded length may vary with their state.
HexDumpBytesDescription<B extends HexDumpBytesDescription<B>>	Provides hooks for adding comments and controlling indentation when generating hex dumps.
Invocation	A functional interface representing the act of invoking a method.
MappedBytesStoreFactory	Factory for creating MappedBytesStore instances.
MethodEncoder	Interface defining the required operations for a method encoder.
MethodReader	Interface defining the required operations for a method reader.
MethodReaderBuilder	Interface for a builder that constructs instances of MethodReader.
MethodReaderInterceptorReturns	Functional interface representing an interceptor for methods invoked through a MethodReader.
MethodWriterBuilder<T>	Interface for creating a builder that will generate a MethodWriter instance of a specific type.
MethodWriterInterceptorReturns	Functional interface representing an interceptor for methods invoked through a MethodWriter.
MethodWriterInvocationHandler	Interface for handling invocations in a MethodWriter.
MultiReaderBytesRingBuffer	Extension of the BytesRingBuffer interface that supports multiple readers.
NewChunkListener	Listener notified when a new chunk is allocated by a MappedFile.
OffsetFormat	Strategy for formatting offsets when dumping bytes.
RandomCommon	A foundational interface for random access to a byte sequence or buffer.
RandomDataInput	The RandomDataInput class provides a series of methods for reading data from various types of inputs.
RandomDataOutput<R extends RandomDataOutput<R>>	Provides methods for writing data to a byte sequence or buffer at arbitrary offsets.
ReadBytesMarshallable	Functional interface to facilitate the reading of data directly as Bytes.
RingBufferReader	An interface for a reader on a Ring Buffer, providing methods to read and navigate through the buffer.
RingBufferReaderStats	An interface to provide statistics about a RingBufferReader's reading operations.
StopCharsTester	A functional interface that defines a strategy for identifying stop characters during a string parsing operation.
StopCharTester	A functional interface for defining a strategy to identify stop characters during string parsing.
StreamingCommon<S extends StreamingCommon<S>>	A common base interface for streaming data access.
StreamingDataInput<S extends StreamingDataInput<S>>	Provides sequential, cursor based reading of binary and textual data from a stream or buffer.
StreamingDataOutput<S extends StreamingDataOutput<S>>	Provides sequential, cursor based writing of binary and textual data to a stream or buffer.
UpdateInterceptor	Represents an operation that intercepts a method call, possibly modifies the input argument, and determines whether to proceed with the original operation.
WriteBytesMarshallable	Functional interface for objects that can serialise their state directly to a BytesOut stream.

Class Summary

Class	Description
AbstractBytes<U>	Provides a base implementation of Bytes with cursor management, optional bounds checking and default text formatting support.
BinaryBytesMethodWriterInvocationHandler	InvocationHandler that serialises method calls to a BytesOut using a MethodEncoder per method.
BytesMarshaller<T>	Reflection-based marshaller for simple objects.
BytesMethodReader	Concrete MethodReader that reads method calls serialised in a binary format from a BytesIn stream and dispatches them to target objects.
BytesMethodReaderBuilder	Builder for BytesMethodReader instances.
BytesTextMethodTester<T>	Utility for exercising an interface backed by Bytes using a textual description of the method calls.
DistributedUniqueTimeProvider	TimeProvider implementation producing timestamps that remain unique across JVMs by embedding a host identifier in the lower bits.
GuardedNativeBytes<U>	Debugging wrapper that prefixes each primitive written with a type code and checks it on reads.
HexDumpBytes	Bytes implementation that records all writes and produces a formatted hexadecimal dump of the data.
MappedBytes	A specialised Bytes implementation backed by a memory-mapped file.
MappedBytesStore	NativeBytesStore backed by a region of a memory-mapped file.
MappedFile	Manages a memory-mapped file and creates MappedBytesStore views over it.
NativeBytes<U>	VanillaBytes backed by native (off heap) memory or a direct ByteBuffer.
OnHeapBytes	VanillaBytes backed by an on heap byte[].
PageUtil	Utility to determine page size for memory mapping, aware of hugetlbfs mounts.
PointerBytesStore	NativeBytesStore providing a view over externally managed memory.
StreamingInputStream	An InputStream adapter that sources its data from a StreamingDataInput.
StreamingOutputStream	An OutputStream adapter that writes its bytes to a StreamingDataOutput.
SubBytes<U>	Represents a fixed size view over a region of another BytesStore.
UncheckedBytes<U>	A wrapper around another Bytes instance that bypasses most bounds checks on read and write operations.
UncheckedNativeBytes<U>	Provides unchecked access to a native BytesStore.
VanillaBytes<U>	Base implementation of Bytes backed by a fixed-capacity BytesStore.

Enum Summary

Enum	Description
AppendableUtil	Utility methods for manipulating Appendable implementations such as StringBuilder and Bytes.
BytesUtil	Collection of helper methods dealing with Bytes, BytesStore and low level byte manipulation.
MappedUniqueTimeProvider	TimeProvider that yields monotonically increasing timestamps shared between JVM processes by using a memory-mapped file.
MethodEncoderLookup	Enum singleton that implements Function interface to lookup and return a MethodEncoder for a given method.
StopCharTesters	A collection of predefined StopCharTester implementations that define common stop character criteria.
SyncMode	Synchronisation options for memory mapped file updates, mirroring the behaviour of msync(2).

Exception Summary

Exception	Description
ConnectionDroppedException	IORuntimeException signalling an unexpected loss of connection, typically used by networking components.
UTFDataFormatRuntimeException	Thrown to indicate a failure when encoding or decoding UTF-8 data.

Annotation Types Summary

Annotation Type	Description
FieldGroup	Groups related fields so a contiguous Bytes view can be created via utilities such as Bytes.forFieldGroup(Object, String).
MethodId	Annotation that denotes a method as having a numeric identifier for efficient encoding.