net.openhft.chronicle.wire

Class VanillaMessageHistory

java.lang.Object

net.openhft.chronicle.wire.SelfDescribingMarshallable

net.openhft.chronicle.wire.VanillaMessageHistory

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, MessageHistory, ReadMarshallable, WriteMarshallable, WriteValue

public class VanillaMessageHistory
extends SelfDescribingMarshallable
implements MessageHistory

Array-backed MessageHistory storing source identifiers, message indices and processing timestamps. Entries are kept in internal arrays up to MESSAGE_HISTORY_LENGTH. The object can be marshalled in a compact binary form or as a verbose textual structure.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_LENGTH The maximum number of bytes this object can take when marshalled in its compact binary form.
static int	MESSAGE_HISTORY_LENGTH The maximum number of source/timing entries that can be stored in a single VanillaMessageHistory instance.

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
VanillaMessageHistory()

Method Summary

Modifier and Type	Method and Description
void	addSource(int id, long index) Adds a new source entry and marks the history as dirty.
boolean	addSourceDetails() Gets the flag that determines whether the MessageHistory should automatically add a timestamp on read.
void	addSourceDetails(boolean addSourceDetails) Sets whether the MessageHistory should automatically add a timestamp on read.
void	addTiming(long l) Adds a timing entry.
net.openhft.chronicle.bytes.util.BinaryLengthLength	binaryLengthLength() Provides an assumed length in bytes for the serialized form of this entity.
<T> T	deepCopy() Override deepCopy as writeMarshallable adds a timing every time it is called.
void	doWriteHistory(DocumentContext dc) Default implementation for recording history into the supplied DocumentContext.
boolean	equals(Object o)
int	hashCode()
void	historyWallClock(boolean historyWallClock) Sets whether to use wall-clock time for new timings.
boolean	isDirty()
int	lastSourceId() Returns the last source id contained in this MessageHistory.
long	lastSourceIndex() Returns the last source index contained in this MessageHistory.
protected long	nanoTime() Returns the timestamp used for new timing entries.
void	readMarshallable(@NotNull net.openhft.chronicle.bytes.BytesIn<?> bytes) Reads the message history data from the provided bytes input.
void	readMarshallable(@NotNull WireIn wire) Deserialises this history from a WireIn.
void	reset() Clears all recorded entries.
void	reset(int sourceId, long sourceIndex) Initialise the history with the given source and current time.
int	sourceId(int n) Returns the source id at a position specified by the input n.
boolean	sourceIdsEndsWith(int[] sourceIds) Returns true if the source ids contained in this MessageHistory end with the provided sourceIds.
long	sourceIndex(int n) Returns the index of the source at a position specified by the input n.
int	sources() Returns the number of sources contained in this MessageHistory.
long	timing(int n) Returns a timing at a position specified by the input n.
int	timings() Returns the number of timings contained in this MessageHistory.
String	toString() We need a custom toString as the base class toString calls writeMarshallable which does not mutate this, but will display a different result every time you toString the object as it outputs System.nanoTime or Wall Clock in NS if the wall.clock.message.history system property is set
void	useBytesMarshallable(boolean useBytesMarshallable) Sets whether to use the compact binary form when writing.
void	writeMarshallable(@NotNull net.openhft.chronicle.bytes.BytesOut<?> b) Serialises to the compact binary representation.
void	writeMarshallable(@NotNull WireOut wire) Serialises this history to the given wire.
void	writeMarshallable0(@NotNull net.openhft.chronicle.bytes.BytesOut<?> b) Fallback binary serialisation when direct memory is unavailable.

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.MessageHistory

clear, emptyHistory, get, set, writeHistory

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

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

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

writeValue

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

unexpectedField

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

usesSelfDescribingMessage

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

$toString

Field Detail

MESSAGE_HISTORY_LENGTH

public static final int MESSAGE_HISTORY_LENGTH

The maximum number of source/timing entries that can be stored in a single VanillaMessageHistory instance.

See Also:

Constant Field Values

MAX_LENGTH

public static final int MAX_LENGTH

The maximum number of bytes this object can take when marshalled in its compact binary form.

See Also:

Constant Field Values

Constructor Detail

VanillaMessageHistory

public VanillaMessageHistory()

Method Detail

addSourceDetails

public void addSourceDetails(boolean addSourceDetails)

Sets whether the MessageHistory should automatically add a timestamp on read. Useful for utilities that expect to read MessageHistory without mutation.

Parameters:

addSourceDetails - True if source details should be added, false otherwise.

reset

public void reset()

Clears all recorded entries.

Specified by:

reset in interface net.openhft.chronicle.core.io.Resettable

Specified by:

reset in interface Marshallable

Specified by:

reset in interface MessageHistory

addSourceDetails

public boolean addSourceDetails()

Gets the flag that determines whether the MessageHistory should automatically add a timestamp on read.

Returns:

True if source details are being added, false otherwise.

reset

public void reset(int sourceId,
                  long sourceIndex)

Initialise the history with the given source and current time.

Specified by:

reset in interface MessageHistory

Parameters:

sourceId - source identifier

sourceIndex - index from the calling component

lastSourceId

public int lastSourceId()

Description copied from interface: MessageHistory

Returns the last source id contained in this MessageHistory.

Specified by:

lastSourceId in interface MessageHistory

Returns:

source id of the most recent entry or -1 if none

lastSourceIndex

public long lastSourceIndex()

Description copied from interface: MessageHistory

Returns the last source index contained in this MessageHistory.

Specified by:

lastSourceIndex in interface MessageHistory

Returns:

source index of the most recent entry or -1 if none

timings

public int timings()

Description copied from interface: MessageHistory

Returns the number of timings contained in this MessageHistory.

Specified by:

timings in interface MessageHistory

Returns:

number of timing entries recorded

timing

public long timing(int n)

Description copied from interface: MessageHistory

Returns a timing at a position specified by the input n.

Specified by:

timing in interface MessageHistory

Parameters:

n - index of the entry

Returns:

raw timestamp value

sources

public int sources()

Description copied from interface: MessageHistory

Returns the number of sources contained in this MessageHistory.

Specified by:

sources in interface MessageHistory

Returns:

number of source entries recorded

sourceId

public int sourceId(int n)

Description copied from interface: MessageHistory

Returns the source id at a position specified by the input n.

Specified by:

sourceId in interface MessageHistory

Parameters:

n - index of the entry

Returns:

source id stored at that position

sourceIdsEndsWith

public boolean sourceIdsEndsWith(int[] sourceIds)

Description copied from interface: MessageHistory

Returns true if the source ids contained in this MessageHistory end with the provided sourceIds.

Specified by:

sourceIdsEndsWith in interface MessageHistory

Returns:

true if the recorded source ids end with the given array

sourceIndex

public long sourceIndex(int n)

Description copied from interface: MessageHistory

Returns the index of the source at a position specified by the input n.

Specified by:

sourceIndex in interface MessageHistory

Parameters:

n - index of the entry

Returns:

source index stored at that position

readMarshallable

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

Deserialises this history from a WireIn. Binary wires may hold a compact representation starting with BinaryWireCode.HISTORY_MESSAGE. Structured wires read 'sources' and 'timings' fields. If addSourceDetails is true the caller is appended as another hop.

Specified by:

readMarshallable in interface Marshallable

Specified by:

readMarshallable in interface ReadMarshallable

Parameters:

wire - The wire input source.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If an IO error occurs during the read operation.

net.openhft.chronicle.core.io.InvalidMarshallableException - If there's an error during marshalling.

writeMarshallable

public void writeMarshallable(@NotNull
                              @NotNull WireOut wire)

Serialises this history to the given wire. Uses the compact binary form when useBytesMarshallable is true and the wire is binary, otherwise writes 'sources' and 'timings' sequences. Resets the dirty flag.

Specified by:

writeMarshallable in interface Marshallable

Specified by:

writeMarshallable in interface WriteMarshallable

Parameters:

wire - The wire output destination.

readMarshallable

public void readMarshallable(@NotNull
                             @NotNull net.openhft.chronicle.bytes.BytesIn<?> bytes)
                      throws net.openhft.chronicle.core.io.IORuntimeException

Reads the message history data from the provided bytes input.

Specified by:

readMarshallable in interface net.openhft.chronicle.bytes.BytesMarshallable

Specified by:

readMarshallable in interface net.openhft.chronicle.bytes.ReadBytesMarshallable

Parameters:

bytes - Input bytes to read the data from.

Throws:

net.openhft.chronicle.core.io.IORuntimeException

writeMarshallable

public void writeMarshallable(@NotNull
                              @NotNull net.openhft.chronicle.bytes.BytesOut<?> b)

Serialises to the compact binary representation.

Specified by:

writeMarshallable in interface net.openhft.chronicle.bytes.BytesMarshallable

Specified by:

writeMarshallable in interface net.openhft.chronicle.bytes.WriteBytesMarshallable

writeMarshallable0

public void writeMarshallable0(@NotNull
                               @NotNull net.openhft.chronicle.bytes.BytesOut<?> b)

Fallback binary serialisation when direct memory is unavailable.

nanoTime

protected long nanoTime()

Returns the timestamp used for new timing entries. Uses wall-clock time when historyWallClock is true, otherwise System.nanoTime().

addSource

public void addSource(int id,
                      long index)

Adds a new source entry and marks the history as dirty.

Parameters:

id - source identifier

index - source index

isDirty

public boolean isDirty()

Specified by:

isDirty in interface MessageHistory

Returns:

true if the message history has not been written using Marshallable.writeMarshallable(net.openhft.chronicle.wire.WireOut)

addTiming

public void addTiming(long l)

Adds a timing entry. Throws IllegalStateException if the capacity is exceeded.

toString

public String toString()

We need a custom toString as the base class toString calls writeMarshallable which does not mutate this, but will display a different result every time you toString the object as it outputs System.nanoTime or Wall Clock in NS if the wall.clock.message.history system property is set

Returns:

String representation

deepCopy

@NotNull
public <T> T deepCopy()
                        throws net.openhft.chronicle.core.io.InvalidMarshallableException

Override deepCopy as writeMarshallable adds a timing every time it is called. See also toString()

Specified by:

deepCopy in interface Marshallable

Returns:

copy of this

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

binaryLengthLength

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

Description copied from interface: WriteMarshallable

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.

Specified by:

binaryLengthLength in interface WriteMarshallable

Returns:

The binary length length indicating the size in bytes.

doWriteHistory

public void doWriteHistory(DocumentContext dc)

Description copied from interface: MessageHistory

Default implementation for recording history into the supplied DocumentContext. It writes an event named MethodReader.HISTORY with this history as the value.

Specified by:

doWriteHistory in interface MessageHistory

Parameters:

dc - the document to append the history to

useBytesMarshallable

public void useBytesMarshallable(boolean useBytesMarshallable)

Sets whether to use the compact binary form when writing.

historyWallClock

public void historyWallClock(boolean historyWallClock)

Sets whether to use wall-clock time for new timings.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object