Package net.openhft.chronicle.wire

Interface Summary

Interface	Description
BaseEvent<E extends BaseEvent<E>>	Represents a timed event and extends Marshallable so that the event can be serialised or de-serialised.
ChronicleBitSet	Interface for a bit set that is both Marshallable and Closeable.
Demarshallable	Represents a contract for objects that are designed for deserialization, with an expectation that a new, potentially immutable object is instantiated during each deserialization process.
DocumentContext	Represents a context that governs the interactions and state management for a document.
DocumentWritten	Represents an entity that supports writing documents.
DynamicEnum	Deprecated
Event<E extends Event<E>>	Represents a business or system occurrence identified by an ID and time.
ExcerptListener	A listener interface for receiving events when excerpts are encountered.
FieldInfo	Represents an abstraction for the meta-information of a field within a class or interface.
FieldNumberParselet	Parses fields identified by a numeric ID.
GeneratingMethodReaderInterceptorReturns	Version of MethodReaderInterceptorReturns that lets generated readers inline custom logic without reflection overhead.
HeadNumberChecker	Represents a functional interface for checking header numbers against specific criteria.
KeyedMarshallable	A Marshallable that exposes a portion of its state as a key.
LongConverter	Defines a contract for converting long values to and from textual representations.
Marshallable	A cornerstone interface for objects that need to be serialised to and deserialised from a wire format.
MarshallableIn	This interface provides methods for reading marshallable objects.
MarshallableOut	Defines the contract for objects that can write out Marshallable objects.
MarshallableParser<T>	Functional interface describing a strategy for deserialising data.
MessageHistory	Records the path a message takes as it moves through components.
MethodDelegate<OUT>	Represents an interface that provides a mechanism for method delegation.
MethodFilterOnFirstArg<T>	Represents a functional interface that provides a mechanism to filter methods based on their first argument.
MethodWriter	Defines a contract for components that can serialise method calls to a MarshallableOut target.
ObjectIntObjectConsumer<T,V>	Represents a consumer that accepts two objects of types T and V, and an integer value.
ReadDocumentContext	Represents a context for reading documents.
ReadMarshallable	This interface represents objects that can be reloaded from a stream by reusing an existing instance.
RollbackIfNotCompleteNotifier	The RollbackIfNotCompleteNotifier interface defines methods to handle rollback scenarios in the event of incomplete operations or messages.
Sequence	Defines a contract for mapping a write position (typically in a persistent store such as Chronicle Queue) to a logical sequence number, and vice versa.
SerializationStrategy	Strategy for serialising and deserialising objects of type T.
SourceContext	Interface for accessing metadata about the origin of a message.
TriConsumer<T,U,V>	Represents an operation that accepts three input arguments and returns no result.
Validate	Interface for validating objects.
ValueIn	Represents an interface for reading values in various formats from a serialized data source.
ValueIn.Reader	Interface for reading values from the wire into a list.
ValueOut	Defines an interface for writing out values after writing a field.
Wire	Defines the standard interface for sequentially writing to and reading from a Bytes stream.
WireCommon
WireIn	Defines the standard interface for reading sequentially from a Bytes stream.
WireKey	Represents a unique identifier or key for wiring protocols.
WireOut	Defines the standard interface for sequential writing to a Bytes stream.
WireParselet	Functional interface invoked when a field name is parsed.
WireParser	Defines a contract for parsing field-value data from a WireIn stream.
WriteDocumentContext	This is the WriteDocumentContext interface extending DocumentContext.
WriteMarshallable	Represents a marshallable entity capable of writing its state to a given wire format.
WriteValue	Represents an entity capable of writing its value to a specified output format.

Class Summary

Class	Description
AbstractAnyWire	An abstract representation of a wire type that could be either TextWire or BinaryWire.
AbstractClassGenerator<M extends AbstractClassGenerator.MetaData<M>>	Abstract generator for classes at runtime based on meta-data.
AbstractClassGenerator.MetaData<M extends AbstractClassGenerator.MetaData<M>>	Represents the metadata configuration required for the class generator.
AbstractEventCfg<E extends AbstractEventCfg<E>>	The AbstractEventCfg class represents a generic configuration as an event.
AbstractFieldInfo	The AbstractFieldInfo class serves as an abstract foundation for field information.
AbstractGeneratedMethodReader	Abstract base class for generated method readers.
AbstractLongConverter	An abstract class that serves as a base implementation for the LongConverter interface.
AbstractMarshallableCfg	An abstract class that represents a configuration Data Transfer Object (DTO) capable of marshalling.
AbstractMethodWriterInvocationHandler	An abstract base for MethodWriterInvocationHandlers that provides a base implementation.
AbstractTimestampLongConverter	This abstract class serves as the base for LongConverters that handle timestamp values.
AbstractWire	Represents the AbstractWire class which serves as a base for all Wire implementations.
Base32LongConverter	This class is responsible for converting 64-bit unsigned numbers into a base32 representation.
Base64LongConverter	This class represents a converter for an unsigned 64-bit number encoded in base64.
Base85LongConverter	Provides a Base85 encoding scheme, converting long values to a string representation.
BinaryMethodWriterInvocationHandler	MethodWriterInvocationHandler that serialises method calls to a MarshallableOut using the binary wire format.
BinaryReadDocumentContext	This is the BinaryReadDocumentContext class which implements the ReadDocumentContext interface.
BinaryWire	Primary implementation of the binary wire format.
BinaryWriteDocumentContext	A context used for writing documents in a binary format.
BytesInBinaryMarshallable	Represents an abstract base class for binary marshallables that primarily deal with bytes.
CharSequenceObjectMap<T>	Simple hash map implementation optimised for CharSequence keys.
CSVWire	Text based wire format for Comma Separated Values (CSV).
DefaultValueIn	This class provides the default implementation for the ValueIn interface.
DocumentContextHolder	This is the DocumentContextHolder class which implements both DocumentContext and WriteDocumentContext.
GenerateJsonSchemaMain	This is the GenerateJsonSchemaMain class.
GenerateMethodBridge	Dynamically creates a class that implements a destination interface and forwards method calls to a collection of handler objects.
GenerateMethodDelegate	Dynamically generates a class that implements MethodDelegate and the additional interfaces supplied in AbstractClassGenerator.MetaData.interfaces().
GenerateMethodDelegate.GMDMetaData	Metadata for GenerateMethodDelegate.
GenerateMethodReader	Responsible for code generation and runtime compilation of custom MethodReaders.
GenerateMethodWriter	Dynamically generates and compiles Java code for method writer proxies.
GenerateMethodWriter2	The GenerateMethodWriter2 class is responsible for generating method writers based on the provided metadata.
GenerateMethodWriter2.GMWMetaData	Metadata associated with the GenerateMethodWriter2 class.
HashWire	A specialised WireOut used only for hashing.
HexadecimalLongConverter	The HexadecimalLongConverter class is responsible for converting 64-bit unsigned numbers into a hexadecimal representation.
IdentifierLongConverter	An identifier that acts as a base 66 string of up to 10 characters, or a nanosecond timestamp for dates from 2019-09-14.
InputStreamToWire	Provides a bridge to read structured data in Chronicle Wire format from a standard Java InputStream.
JSONWire	Represents the JSON wire format for text-based marshalling and parsing.
LongArrayValueBitSet	A ChronicleBitSet backed by a LongArrayValues.
LongValueBitSet	A ChronicleBitSet implementation backed by an array of LongValues.
MarshallableOutBuilder	This is the MarshallableOutBuilder class.
MessagePathClassifier	Classifies message paths based on the history of each message.
MethodWireKey	The MethodWireKey class represents a key within a wire format, extending the BytesInBinaryMarshallable class and implementing the WireKey interface.
MethodWriterInvocationHandlerSupplier	Configurable factory for MethodWriterInvocationHandler instances.
MicroDurationLongConverter	Implementation of LongConverter to convert durations represented as microseconds.
MicroTimestampLongConverter	A MicroTimestampLongConverter is an implementation of AbstractTimestampLongConverter which handles conversions between long timestamps and date-time strings.
MilliTimestampLongConverter	A MilliTimestampLongConverter is an implementation of AbstractTimestampLongConverter which handles conversions between long timestamps and date-time strings.
NanoDurationLongConverter	Implementation of LongConverter for converting durations represented as nanoseconds.
NanoTimestampLongConverter	A NanoTimestampLongConverter is an implementation of AbstractTimestampLongConverter which handles conversions between long timestamps and date-time strings.
QueryWire	Parses a URL query string such as "a=1&b=2".
RawWire	Wire implementation that serialises values in sequence without any field names.
ReadAnyWire	Represents a wire type that can be either TextWire or BinaryWire.
ReflectionUtil	A utility class for handling reflection-based tasks.
SelfDescribingMarshallable	Represents an abstraction of marshallable objects that are self-describing by default.
SelfDescribingTriviallyCopyable	Represents a self-describing object that is trivially copyable, extending the functionality of SelfDescribingMarshallable.
ServicesTimestampLongConverter	This is the ServicesTimestampLongConverter class implementing the LongConverter interface.
ShortTextLongConverter	Implements a Base 85 encoding scheme specifically designed for converting short text strings into long values.
TextMethodWriterInvocationHandler	A MethodWriterInvocationHandler that serialises method calls to a text-based MarshallableOut such as YAML or JSON.
TextReadDocumentContext	This class represents the context for reading a document in textual format.
TextWire	A representation of the YAML-based wire format.
TextWriteDocumentContext	Provides a concrete implementation of the WriteDocumentContext for text-based wire representations.
VanillaMessageHistory	Array-backed MessageHistory storing source identifiers, message indices and processing timestamps.
VanillaMethodReader	Deserialises messages from a MarshallableIn source and dispatches each one as a method call on the supplied handler objects.
VanillaMethodReaderBuilder	Builder for VanillaMethodReader.
VanillaMethodWriterBuilder<T>	Builder for dynamic proxies that write method calls to a MarshallableOut.
VanillaWireParser	Provides an implementation of WireParser that maps field names or ids to WireParselets.
WireDumper	The WireDumper class provides utility methods to obtain a human-readable dump representation of WireIn content.
WireMarshaller<T>	Engine for marshalling and unmarshalling objects based on their field definitions.
WireMarshallerForUnexpectedFields<T>	This class extends the WireMarshaller and provides the ability to handle unexpected fields.
WireSerializedLambda	Helper class to support the serialisation of lambda expressions in Wire formats.
WireToOutputStream	Provides a bridge to write structured data in Chronicle Wire format to a standard Java OutputStream.
WireTypeConverter	This is the WireTypeConverter class responsible for converting between different wire types such as JSON and YAML.
WordsLongConverter	The WordsLongConverter class implements the LongConverter interface.
WrappedDocumentContext	This is the WrappedDocumentContext class which implements the DocumentContext interface.
YamlKeys	Represents a collection of offsets used in a YAML structure.
YamlTokeniser	A tokenizer for YAML documents.
YamlWire	Represents a YAML-based wire format designed for efficient parsing and serialization of data.
YamlWireOut<T extends YamlWireOut<T>>	Provides functionality for writing data in a YAML-based wire format.

Enum Summary

Enum	Description
BinaryWireCode	Enumerates the predefined byte codes for the Binary YAML wire format.
BinaryWireHighCode	Enum to represent various high-level codes used in the binary wire protocol.
BracketType	Represents the type of bracketing used in serialized data formats, particularly in the context of Chronicle Wire serialization/deserialization processes.
GeneratedProxyClass	This is the GeneratedProxyClass enum.
NoDocumentContext	An enumeration implementation of the DocumentContext interface.
SerializationStrategies	Enumerates the available serialization strategies, each implementing the SerializationStrategy interface.
WireIn.HeaderType	Enumeration representing possible header types that can be read from a WireIn instance.
WireInternal	The WireInternal enum provides a collection of utility constants, data structures, and internal configurations to support wire operations.
WireOut.EndOfWire
Wires	Utility holder for low-level wire constants and helper methods.
WireType	Enumerates a selection of prebuilt wire types.
YamlLogging	Provides utility functions to control the logging of Yaml messages, which can be useful for debugging or generating documentation.
YamlLogging.YamlLoggingLevel	Enum representing the various logging levels for Yaml.
YamlToken	Enumerates the different types of tokens that can be found in a YAML document.

Exception Summary

Exception	Description
MethodWriterValidationException	Exception thrown when a generated MethodWriter cannot be created.
UnexpectedFieldHandlingException	Wrapper exception used to encapsulate and propagate exceptions to high-level API calls that arise from ReadMarshallable.unexpectedField(Object, ValueIn).
UnrecoverableTimeoutException	Represents an unrecoverable timeout exception, indicating that a certain operation or request exceeded its allotted time and cannot be recovered or retried.
WriteAfterEOFException	This is the WriteAfterEOFException class extending IllegalStateException.

Annotation Types Summary

Annotation Type	Description
AsMarshallable	This annotation indicates that the associated field or parameter should be treated as a Marshallable type, implying it should be serialized or deserialized accordingly.
Comment	The Comment annotation represents a way to attach user-defined comments to elements such as fields, parameters or types.
FieldOrder	Defines the marshalling order for fields declared directly on the annotated class.
LongConversion	Meta-annotation used to associate a concrete LongConverter implementation with another annotation.