net.openhft.chronicle.wire

Interface ReadMarshallable

All Superinterfaces:

net.openhft.chronicle.bytes.CommonMarshallable

All Known Subinterfaces:

BaseEvent<E>, ChannelHandler, ChannelHeader, ChronicleBitSet, DynamicEnum, Event<E>, Marshallable, MessageHistory

All Known Implementing Classes:

AbstractClassGenerator.MetaData, AbstractEventCfg, AbstractHandler, AbstractHeader, AbstractMarshallableCfg, BytesInBinaryMarshallable, ChronicleChannelCfg, ChronicleChannelSupplier, ChronicleServiceMain, EchoHandler, ErrorHeader, ErrorReplyHandler, GatewayHandler, GenerateMethodDelegate.GMDMetaData, GenerateMethodWriter2.GMWMetaData, HostPortCfg, LongArrayValueBitSet, LongValueBitSet, MethodWireKey, OkHeader, RedirectHeader, Reductions.Counting, ReplyHeader, ReplyingHandler, SelfDescribingMarshallable, SelfDescribingTriviallyCopyable, SystemContext, VanillaMessageHistory, WireSerializedLambda

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ReadMarshallable
extends net.openhft.chronicle.bytes.CommonMarshallable

This interface represents objects that can be reloaded from a stream by reusing an existing instance. Instead of creating a new object every time the data is read from a stream, instances implementing this interface can update their state based on the stream content, thereby potentially improving performance and reducing garbage.

For objects which need to deserialize final fields, consider using the Demarshallable interface.

Example usage might involve reading an object's state from a file or network stream without allocating a new object on each read operation.

Field Summary

Fields

Modifier and Type	Field and Description
static ReadMarshallable	DISCARD

Method Summary

Modifier and Type	Method and Description
void	readMarshallable(@NotNull WireIn wire) Reads the object's state from the given wire input.
default void	unexpectedField(Object event, ValueIn valueIn) Handles unexpected fields encountered during the deserialization process.

Methods inherited from interface net.openhft.chronicle.bytes.CommonMarshallable

usesSelfDescribingMessage

Field Detail

DISCARD

static final ReadMarshallable DISCARD

Method Detail

readMarshallable

void readMarshallable(@NotNull
                      @NotNull WireIn wire)
               throws net.openhft.chronicle.core.io.IORuntimeException,
                      net.openhft.chronicle.core.io.InvalidMarshallableException

Reads the object's state from the given wire input. Implementations should update the current instance's state based on the content of the wire.

Parameters:

wire - The wire input from which the object's state should be read.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If there's an error reading from the wire.

net.openhft.chronicle.core.io.InvalidMarshallableException - If the data in the wire is not as expected or invalid.

unexpectedField

default void unexpectedField(Object event,
                             ValueIn valueIn)
                      throws net.openhft.chronicle.core.io.InvalidMarshallableException

Handles unexpected fields encountered during the deserialization process. Default behavior is to skip the unexpected value. Override this method if a different behavior is required.

Parameters:

event - The event or field identifier that was unexpected.

valueIn - The value associated with the unexpected field.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - If the unexpected field cannot be processed.