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

The VanillaMessageHistory class is an implementation of MessageHistory that provides an array-backed history of messages.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_LENGTH
static int	MESSAGE_HISTORY_LENGTH

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 with the given ID and index to the message history.
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 value to the message history.
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)
boolean	equals(Object o)
int	hashCode()
void	historyWallClock(boolean historyWallClock)
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 current time in nanoseconds.
void	readMarshallable(@NotNull net.openhft.chronicle.bytes.BytesIn<?> bytes) Reads the message history data from the provided bytes input.
void	readMarshallable(@NotNull WireIn wire) Reads the state of the Marshallable object from the given wire input.
void	reset() Clears all data contained in this MessageHistory
void	reset(int sourceId, long sourceIndex) Resets the MessageHistory with the provided sourceId and sourceIndex as a starting point.
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)
void	writeMarshallable(@NotNull net.openhft.chronicle.bytes.BytesOut<?> b)
void	writeMarshallable(@NotNull WireOut wire) Writes the state of the Marshallable object to the given wire output.
void	writeMarshallable0(@NotNull net.openhft.chronicle.bytes.BytesOut<?> b)

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

See Also:

Constant Field Values

MAX_LENGTH

public static final int MAX_LENGTH

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

Description copied from interface: MessageHistory

Clears all data contained in this MessageHistory

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)

Description copied from interface: MessageHistory

Resets the MessageHistory with the provided sourceId and sourceIndex as a starting point.

Specified by:

reset in interface MessageHistory

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:

the last source id contained in this MessageHistory.

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:

the last source index contained in this MessageHistory.

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:

the number of timings contained in this MessageHistory.

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

Returns:

a timing at a position specified by the input n.

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:

the number of sources contained in this MessageHistory.

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

Returns:

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

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 source ids contained in this MessageHistory end with the provided sourceIds.

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

Returns:

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

readMarshallable

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

Description copied from interface: Marshallable

Reads the state of the Marshallable object from the given wire input. The method obtains a WireMarshaller specific to the class of the current object and delegates the reading process to that marshaller.

The default implementation will use a default value for each field not present

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)

Description copied from interface: Marshallable

Writes the state of the Marshallable object to the given wire output. The method obtains a WireMarshaller specific to the class of the current object and delegates the writing process to that marshaller.

The default implementation will write all values even if they are a default value. c.f. readMarshallable

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)

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)

nanoTime

protected long nanoTime()

Returns the current time in nanoseconds.

Returns:

Current time in nanoseconds.

addSource

public void addSource(int id,
                      long index)

Adds a new source with the given ID and index to the message history.

Parameters:

id - The ID of the source.

index - The index of the source.

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 value to the message history. Throws an exception if the maximum capacity is reached.

Parameters:

l - The timing value to be added.

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)

Specified by:

doWriteHistory in interface MessageHistory

useBytesMarshallable

public void useBytesMarshallable(boolean useBytesMarshallable)

historyWallClock

public void historyWallClock(boolean historyWallClock)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object