Package net.openhft.chronicle.wire

Interface Summary

Interface	Description
BaseEvent<E extends BaseEvent<E>>	This interface represents a timed event, providing methods to manage and access the time associated with the event.
CharConverter	Deprecated
ChronicleBitSet
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>>	This interface defines the structure and behavior of an event within a system.
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	Represents a parselet to process field numbers in a wire format.
GeneratingMethodReaderInterceptorReturns	This interface is a version of method reader interceptor that allows to change the logic of MethodReader without overhead provided by reflexive calls.
HeadNumberChecker	Represents a functional interface for checking header numbers against specific criteria.
KeyedMarshallable
LongConverter	Provides an abstraction for converting between long values and their string representations, potentially based on a custom character or symbol set.
Marshallable	Represents a data structure that supports both reading from and writing to marshallable formats.
MarshallableIn	This interface provides methods for reading marshallable objects.
MarshallableOut	Defines the contract for objects that can write out Marshallable objects.
MarshallableParser<T>	This is the MarshallableParser functional interface.
MessageHistory	This is the MessageHistory interface, which extends Marshallable.
MethodDelegate<OUT>	Represents an interface that provides a mechanism for method delegation.
MethodFilter	Deprecated
MethodFilterOnFirstArg<T>	Represents a functional interface that provides a mechanism to filter methods based on their first argument.
MethodWriter	The MethodWriter interface defines the contract for classes that have the capability to output their data in a marshallable format using the MarshallableOut interface.
MethodWriterWithContext	Deprecated
ObjectIntObjectConsumer<T,V>	Represents a consumer that accepts two objects of types T and V, and an integer value.
ParameterizeWireKey	Deprecated
ReadDocumentContext	Represents a context for reading documents.
ReadingMarshaller<T>	Deprecated
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	This is used in Chronicle-Queue to map a position to a sequence number.
SerializationStrategy	Represents a strategy for serializing and deserializing objects of type T.
SourceContext	This is the SourceContext interface.
TextMethodTester.PostSetup	Represents an action that should be performed after a setup procedure.
TriConsumer<T,U,V>	Represents an operation that accepts three input arguments and returns no result.
Validate	This is the Validate interface.
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.
ValueWriter<T>	Deprecated
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	Represents a functional interface that can process wire input based on a given character sequence key and a value input.
WireParser	Defines the interface for parsing arbitrary field-value data from wire input.
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.
WritingMarshaller<T>	Deprecated

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	This is the AbstractGeneratedMethodReader class implementing the MethodReader interface.
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 handler for method writer invocations 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	The BinaryMethodWriterInvocationHandler handles method invocations specific to binary writing scenarios with optional metadata support.
BinaryReadDocumentContext	This is the BinaryReadDocumentContext class which implements the ReadDocumentContext interface.
BinaryWire	Represents a binary translation of TextWire, which is a subset of YAML.
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>	This class provides a simple hash map implementation optimized for CharSequence keys and generic values.
CSVWire	Represents a CSV (Comma Separated Values) based wire format.
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	This is the GenerateMethodBridge class, extending AbstractClassGenerator with MethodBridgeMetaData.
GenerateMethodDelegate	This is the GenerateMethodDelegate class, extending AbstractClassGenerator with GMDMetaData.
GenerateMethodDelegate.GMDMetaData	This is an inner static class representing metadata for GenerateMethodDelegate.
GenerateMethodReader	Responsible for code generation and its runtime compilation of custom MethodReaders.
GenerateMethodWriter	This is the GenerateMethodWriter class responsible for generating method writer code.
GenerateMethodWriter2	The GenerateMethodWriter2 class is responsible for generating method writers based on the provided metadata.
GenerateMethodWriter2.GMWMetaData	Metadata associated with the GenerateMethodWriter2 class.
HashWire	The HashWire class is responsible for generating hash values from provided objects or WriteMarshallable instances.
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	The InputStreamToWire class provides functionality to read data from an InputStream and convert it to a Wire representation.
JSONWire	Represents the JSON wire format.
LongArrayValueBitSet	This ChronicleBitSet is intended to be shared between processes.
LongValueBitSet	This is the LongValueBitSet class extending AbstractCloseable.
MarshallableOutBuilder	This is the MarshallableOutBuilder class.
MessagePathClassifier	Deprecated
MethodWireKey	The MethodWireKey class represents a key within a wire format, extending the BytesInBinaryMarshallable class and implementing the WireKey interface.
MethodWriterInvocationHandlerSupplier	The MethodWriterInvocationHandlerSupplier class is an implementation of the Supplier interface for providing instances of MethodWriterInvocationHandler.
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	This class represents a wire format designed to decode URL query strings.
RawWire	Represents a wire type that focuses on writing pure data, omitting any metadata.
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.
TextMethodTester<T>	Provides a tester for methods with text input, primarily focused on YAML testing.
TextMethodWriterInvocationHandler	This class represents an invocation handler specifically for text method writers.
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.
ValueOut.MapMarshaller<K,V>	MapMarshaller is a utility for serializing a Map into a Wire format.
VanillaMessageHistory	The VanillaMessageHistory class is an implementation of MessageHistory that provides an array-backed history of messages.
VanillaMethodReader	This is the VanillaMethodReader class implementing the MethodReader interface.
VanillaMethodReaderBuilder	The VanillaMethodReaderBuilder class implements the MethodReaderBuilder interface.
VanillaMethodWriterBuilder<T>	This is the VanillaMethodWriterBuilder class implementing both Builder and MethodWriterBuilder interfaces.
VanillaWireParser	Provides an implementation of the WireParser interface, parsing wire inputs using both named and numbered parselets to associate specific actions with events or field names.
WireDumper
WireMarshaller<T>	The WireMarshaller class is responsible for marshalling and unmarshalling of objects of type T.
WireMarshallerForUnexpectedFields<T>	This class extends the WireMarshaller and provides the ability to handle unexpected fields.
WireSerializedLambda	Helper class to support the serialization of lambda expressions in Wire formats.
WireToOutputStream	This class bridges between a Wire object and a traditional 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.
YamlMethodTester<T>	Extends the TextMethodTester for testing methods with YAML-based wire format.
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
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	The MethodWriterValidationException is a specialized exception class that indicates a failure in generating a MethodWriter.
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 like fields, parameters, or types.
LongConversion	Annotation to specify the conversion strategy for a `long` value.