net.openhft.chronicle.wire

Class SelfDescribingTriviallyCopyable

java.lang.Object

net.openhft.chronicle.wire.SelfDescribingMarshallable

net.openhft.chronicle.wire.SelfDescribingTriviallyCopyable

All Implemented Interfaces:

net.openhft.chronicle.bytes.BytesMarshallable, net.openhft.chronicle.bytes.CommonMarshallable, net.openhft.chronicle.bytes.ReadBytesMarshallable, net.openhft.chronicle.bytes.WriteBytesMarshallable, net.openhft.chronicle.core.io.Resettable, Marshallable, ReadMarshallable, WriteMarshallable, WriteValue

public abstract class SelfDescribingTriviallyCopyable
extends SelfDescribingMarshallable

Represents a self-describing object that is trivially copyable, extending the functionality of SelfDescribingMarshallable. The class provides mechanisms to efficiently manage the internal data layout of an instance based on various data types such as longs, ints, shorts, and bytes. Useful for high-performance scenarios where the layout determined using a description integer is known and stable yet the object remains self-describing when marshalled.

Field Summary

Fields inherited from interface net.openhft.chronicle.wire.WriteMarshallable

EMPTY

Fields inherited from interface net.openhft.chronicle.wire.ReadMarshallable

DISCARD

Constructor Summary

Constructors

Constructor and Description
SelfDescribingTriviallyCopyable()

Method Summary

Modifier and Type	Method and Description
protected abstract int	$description() Fetches the description of the current data layout.
protected abstract int	$length() Fetches the total length of the data based on its layout.
protected abstract int	$start() Determines the starting offset for the data.
boolean	equals(Object o)
int	hashCode()
void	readMarshallable(net.openhft.chronicle.bytes.BytesIn<?> bytes) Reads the object's state from the bytes.
String	toString()
void	writeMarshallable(net.openhft.chronicle.bytes.BytesOut<?> bytes) Writes the description followed by the trivially copyable fields using an unsafe memory copy.

Methods inherited from class net.openhft.chronicle.wire.SelfDescribingMarshallable

usesSelfDescribingMessage

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.openhft.chronicle.wire.Marshallable

$equals, $fieldInfoMap, $fieldInfos, $hashCode, $toString, className, copyTo, deepCopy, fromFile, fromFile, fromString, fromString, fromString, getField, getLongField, mergeToMap, readMarshallable, reset, setField, setLongField, streamFromFile, streamFromFile, writeMarshallable

Methods inherited from interface net.openhft.chronicle.wire.WriteMarshallable

binaryLengthLength, writeValue

Methods inherited from interface net.openhft.chronicle.wire.ReadMarshallable

unexpectedField

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

$toString

Constructor Detail

SelfDescribingTriviallyCopyable

public SelfDescribingTriviallyCopyable()

Method Detail

$description

protected abstract int $description()

Fetches the description of the current data layout.

Returns:

An integer description of the layout.

$start

protected abstract int $start()

Determines the starting offset for the data.

Returns:

The start offset.

$length

protected abstract int $length()

Fetches the total length of the data based on its layout.

Returns:

The total data length.

readMarshallable

public void readMarshallable(net.openhft.chronicle.bytes.BytesIn<?> bytes)
                      throws net.openhft.chronicle.core.io.IORuntimeException,
                             BufferUnderflowException,
                             IllegalStateException

Reads the object's state from the bytes. If the layout description in the input matches $description(), a fast unsafe copy is performed; otherwise carefulCopy(BytesIn, int) handles schema differences.

Throws:

net.openhft.chronicle.core.io.IORuntimeException

BufferUnderflowException

IllegalStateException

writeMarshallable

public void writeMarshallable(net.openhft.chronicle.bytes.BytesOut<?> bytes)
                       throws IllegalStateException,
                              BufferOverflowException,
                              BufferUnderflowException,
                              ArithmeticException

Writes the description followed by the trivially copyable fields using an unsafe memory copy.

Throws:

IllegalStateException

BufferOverflowException

BufferUnderflowException

ArithmeticException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object