net.openhft.chronicle.wire

Interface Event<E extends Event<E>>

All Superinterfaces:

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

All Known Implementing Classes:

AbstractEventCfg

public interface Event<E extends Event<E>>
extends Marshallable

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
static void	copyEventDetails(Event<?> from, Event<?> to) Rather than getting/setting from one event to the other directly, please use this method as this will make removing eventId easier
default @NotNull CharSequence	eventId() Deprecated.
default E	eventId(@NotNull CharSequence eventId) Assigns a unique identifier to this event.
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(String eventName) Updates event with new event name, updating event time to now if required.

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

eventId

@NotNull
 @Deprecated
default @NotNull CharSequence eventId()

Deprecated.

Returns a unique identifier attached to this event.

Returns:

a unique identifier attached to this event.

eventId

default E eventId(@NotNull
                  @NotNull CharSequence eventId)

Assigns a unique identifier to this event. The input identifier cannot be null.

Parameters:

eventId - unique identifier to assign to this event.

Returns:

this

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.

Returns:

this

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

Updates event with new event name, updating event time to now if required.

Parameters:

eventName - name of the event

copyEventDetails

static void copyEventDetails(Event<?> from,
                             Event<?> to)

Rather than getting/setting from one event to the other directly, please use this method as this will make removing eventId easier

Parameters:

from - from

to - to