net.openhft.chronicle.wire

Class AbstractEventCfg<E extends AbstractEventCfg<E>>

java.lang.Object

net.openhft.chronicle.wire.SelfDescribingMarshallable

net.openhft.chronicle.wire.AbstractMarshallableCfg

net.openhft.chronicle.wire.AbstractEventCfg<E>

Type Parameters:

E - The type parameter extending AbstractEventCfg

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, BaseEvent<E>, Event<E>, Marshallable, ReadMarshallable, WriteMarshallable, WriteValue

public class AbstractEventCfg<E extends AbstractEventCfg<E>>
extends AbstractMarshallableCfg
implements Event<E>

The AbstractEventCfg class represents a generic configuration as an event. It extends the AbstractMarshallableCfg and implements the Event interface. This class provides methods to retrieve and set event properties such as ID, time, and service ID. It also follows the builder pattern, allowing chained method calls.

Field Summary

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
@NotNull String	eventId() Returns the unique identifier for this event.
E	eventId(@NotNull CharSequence eventId) Sets a new identifier for this event.
long	eventTime() Returns the timestamp associated with this event.
E	eventTime(long eventTime) Sets the timestamp for this event.
E	eventTimeNow() Updates the event time with the current system time.
int	hashCode()
boolean	routedTo(String destServiceId) Checks if this event is intended for the given destination service.
@NotNull String	serviceId() Retrieves the service identifier associated with this event.
E	serviceId(String serviceId) This method sets the provided service ID to the instance variable.
String	toString()

Methods inherited from class net.openhft.chronicle.wire.AbstractMarshallableCfg

readMarshallable, unexpectedField, writeMarshallable

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

copyEventDetails, updateEvent

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

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

Methods inherited from interface net.openhft.chronicle.bytes.BytesMarshallable

$toString, readMarshallable, writeMarshallable

Constructor Detail

AbstractEventCfg

public AbstractEventCfg()

Method Detail

eventId

@NotNull
public @NotNull String eventId()

Returns the unique identifier for this event.

Specified by:

eventId in interface Event<E extends AbstractEventCfg<E>>

Returns:

the current event ID

eventId

public E eventId(@NotNull
                 @NotNull CharSequence eventId)

Sets a new identifier for this event.

Specified by:

eventId in interface Event<E extends AbstractEventCfg<E>>

Parameters:

eventId - the unique identifier to assign; must not be null

Returns:

this instance for chaining

eventTime

public long eventTime()

Returns the timestamp associated with this event.

Specified by:

eventTime in interface BaseEvent<E extends AbstractEventCfg<E>>

Returns:

the event time in the unit defined by ServicesTimestampLongConverter

eventTime

public E eventTime(long eventTime)

Sets the timestamp for this event.

Specified by:

eventTime in interface BaseEvent<E extends AbstractEventCfg<E>>

Parameters:

eventTime - the new timestamp, typically in nanoseconds

Returns:

this instance for chaining

eventTimeNow

public E eventTimeNow()

Updates the event time with the current system time.

Specified by:

eventTimeNow in interface BaseEvent<E extends AbstractEventCfg<E>>

Returns:

this instance for chaining

serviceId

@NotNull
public @NotNull String serviceId()

Retrieves the service identifier associated with this event. This ID can be used to route the event to a specific service or to identify the service that originated it.

Returns:

the current service ID

serviceId

public E serviceId(String serviceId)

This method sets the provided service ID to the instance variable.

Parameters:

serviceId - the service ID to set; may be empty if not applicable

Returns:

this instance for chaining

routedTo

public boolean routedTo(String destServiceId)

Checks if this event is intended for the given destination service.

Parameters:

destServiceId - The destination service ID to check against

Returns:

true if the event is routed to the specified service, false otherwise

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object