net.openhft.chronicle.wire

Interface WriteMarshallable

All Superinterfaces:

net.openhft.chronicle.bytes.CommonMarshallable, WriteValue

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, ValueOut.MapMarshaller, VanillaMessageHistory

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 WriteMarshallable
extends WriteValue, net.openhft.chronicle.bytes.CommonMarshallable

Represents a marshallable entity capable of writing its state to a given wire format. Implementations of this interface can describe their serialization logic by defining the writeMarshallable(WireOut) method.

This interface is annotated with @FunctionalInterface, indicating that it is intended to be used primarily for lambda expressions and method references. Furthermore, the @DontChain annotation highlights that implementations should not be chained for certain operations.

Field Summary

Fields

Modifier and Type	Field and Description
static WriteMarshallable	EMPTY Represents an empty marshallable entity that performs no actions when its writeMarshallable method is invoked.

Method Summary

Modifier and Type	Method and Description
default net.openhft.chronicle.bytes.util.BinaryLengthLength	binaryLengthLength() Provides an assumed length in bytes for the serialized form of this entity.
void	writeMarshallable(@NotNull WireOut wire) Write the current state of the marshallable entity to the provided wire.
default void	writeValue(@NotNull ValueOut out) Writes the current state of the marshallable entity as a value to the provided output.

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

usesSelfDescribingMessage

Field Detail

EMPTY

static final WriteMarshallable EMPTY

Represents an empty marshallable entity that performs no actions when its writeMarshallable method is invoked.

Method Detail

writeMarshallable

void writeMarshallable(@NotNull
                       @NotNull WireOut wire)
                throws net.openhft.chronicle.core.io.InvalidMarshallableException

Write the current state of the marshallable entity to the provided wire.

Parameters:

wire - The wire format to write to.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if any serialization error occurs.

writeValue

default void writeValue(@NotNull
                        @NotNull ValueOut out)
                 throws net.openhft.chronicle.core.io.InvalidMarshallableException

Writes the current state of the marshallable entity as a value to the provided output.

Specified by:

writeValue in interface WriteValue

Parameters:

out - The output to write to.

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException - if any serialization error occurs.

binaryLengthLength

default net.openhft.chronicle.bytes.util.BinaryLengthLength binaryLengthLength()

Provides an assumed length in bytes for the serialized form of this entity. This is useful for pre-allocating resources or optimizing serialization and deserialization processes.

Returns:

The binary length length indicating the size in bytes.