net.openhft.chronicle.wire

Interface BaseEvent<E extends BaseEvent<E>>

Type Parameters:

E - The type of the implementing event class

All Superinterfaces:

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

All Known Subinterfaces:

Event<E>

All Known Implementing Classes:

AbstractEventCfg

public interface BaseEvent<E extends BaseEvent<E>>
extends Marshallable

This interface represents a timed event, providing methods to manage and access the time associated with the event. It is typically used for events that have a specific timestamp, such as those generated externally and captured by the system.

The event time is generally represented in nanoseconds. However, this can be adjusted if needed through the system property 'service.time.unit'.

Field Summary

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

EMPTY

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

DISCARD

Method Summary

Modifier and Type	Method and Description
long	eventTime() Returns the time at which the event which triggered this was generated (e.g.
default E	eventTime(long eventTime) Sets the time at which the event which triggered this was generated (e.g.
default E	eventTimeNow() Sets the time at which the event which triggered this was generated (e.g.
default E	updateEvent() Updates event's time with the current time if it hasn't been set.

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

usesSelfDescribingMessage

Method Detail

eventTime

long eventTime()

Returns the time at which the event which triggered this was generated (e.g. the time an event generated externally to the system first entered the system).

By default, the time is represented in nanoseconds. System property 'service.time.unit' can be changed in order to represent time in different units.

Returns:

the time at which the event which triggered this was generated.

eventTime

default E eventTime(long eventTime)

Sets the time at which the event which triggered this was generated (e.g. the time an event generated externally to the system first entered the system).

By default, the time is represented in nanoseconds. System property 'service.time.unit' can be changed in order to represent time in different units.

Parameters:

eventTime - The timestamp to set for the event, in the configured time unit.

Returns:

The current instance of the implementing class.

Throws:

UnsupportedOperationException - if the method is not overridden.

eventTimeNow

default E eventTimeNow()

Sets the time at which the event which triggered this was generated (e.g. the time an event generated externally to the system first entered the system) to the current time.

By default, the time is represented in nanoseconds. System property 'service.time.unit' can be changed in order to represent time in different units.

Returns:

this

updateEvent

default E updateEvent()

Updates event's time with the current time if it hasn't been set.