net.openhft.chronicle.wire

Interface BaseEvent<E extends BaseEvent<E>>

Type Parameters:

E - type of the implementing event

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

Represents a timed event and extends Marshallable so that the event can be serialised or de-serialised. This interface provides methods to manage that associated time

Typically used for events generated outside the system that carry a timestamp. The time unit defaults to nanoseconds but can be overridden globally with the service.time.unit system property.

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() Sets the event time to the current time via eventTimeNow() if the existing eventTime() is not positive.

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

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 time to store, expressed in the service time unit (see ServicesTimestampLongConverter).

Returns:

this event instance for chaining

Throws:

UnsupportedOperationException - if not overridden to store the value

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 event instance

updateEvent

default E updateEvent()

Sets the event time to the current time via eventTimeNow() if the existing eventTime() is not positive.

Returns:

this event instance