net.openhft.chronicle.wire

Interface Event<E extends Event<E>>

Type Parameters:

E - the type of the implementing event class

All Superinterfaces:

BaseEvent<E>, 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 BaseEvent<E>

Represents a business or system occurrence identified by an ID and time. Extends BaseEvent for temporal handling and adds event identification.

NOTE: Only use this interface if the eventId is required as the eventTime is sufficient in most cases. The eventId allows events to be routed or categorised beyond their timestamp.

The self-referential generic <E extends Event<E>> lets implementations return their own type for chaining.

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) Copies the eventId and eventTime from one event to another.
default @NotNull CharSequence	eventId() Identifier used for routing or logging.
default E	eventId(@NotNull CharSequence eventId) Assigns or replaces the identifier.
default E	updateEvent(String eventName) Updates the event ID and sets the time if needed.

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

eventTime, eventTime, eventTimeNow, updateEvent

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
default @NotNull CharSequence eventId()

Identifier used for routing or logging. Defaults to an empty string if none has been set.

Returns:

current identifier, or an empty string when unset

eventId

default E eventId(@NotNull
                  @NotNull CharSequence eventId)

Assigns or replaces the identifier.

Parameters:

eventId - unique identifier to assign, should not be null; an empty string can be used when no specific ID is required

Returns:

this event instance for chaining

updateEvent

default E updateEvent(String eventName)

Updates the event ID and sets the time if needed. The ID is set to eventName when the current ID is empty. If BaseEvent.eventTime() is <= 0 the time is updated via BaseEvent.eventTimeNow().

Parameters:

eventName - name to assign when eventId() is empty

Returns:

this event instance after the update

copyEventDetails

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

Copies the eventId and eventTime from one event to another. Prefer this helper over field access to keep a single point of change.

Parameters:

from - the source Event

to - the target Event