net.openhft.chronicle.wire

Class AbstractEventCfg<E extends AbstractEventCfg<E>>

java.lang.Object

net.openhft.chronicle.wire.AbstractCommonMarshallable

net.openhft.chronicle.wire.SelfDescribingMarshallable

net.openhft.chronicle.wire.AbstractMarshallableCfg

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

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

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

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
@NotNull String	eventId() Returns a unique identifier attached to this event.
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.
E	eventTime(long eventTime) Sets the time at which the event which triggered this was generated (e.g.
E	eventTimeNow() Sets the time at which the event which triggered this was generated (e.g.
void	readMarshallable(@NotNull WireIn wireIn) Straight line ordered decoding.
boolean	routedTo(String destServiceId)
@NotNull String	serviceId() Used for cfg event routing.
E	serviceId(String serviceId)

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

unexpectedField, writeMarshallable

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

usesSelfDescribingMessage

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

equals, hashCode, toString

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

$equals, $fieldInfoMap, $fieldInfos, $hashCode, $toString, className, copyTo, deepCopy, fromFile, fromFile, fromString, fromString, fromString, getField, getLongField, mergeToMap, 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

readMarshallable

public void readMarshallable(@NotNull
                             @NotNull WireIn wireIn)
                      throws net.openhft.chronicle.core.io.IORuntimeException

Description copied from interface: ReadMarshallable

Straight line ordered decoding.

Specified by:

readMarshallable in interface Marshallable

Specified by:

readMarshallable in interface ReadMarshallable

Overrides:

readMarshallable in class AbstractMarshallableCfg

Parameters:

wireIn - to read from in an ordered manner.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - the stream wasn't ordered or formatted as expected.

eventId

@NotNull
public @NotNull String eventId()

Description copied from interface: Event

Returns a unique identifier attached to this event.

Specified by:

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

Returns:

a unique identifier attached to this event.

eventId

public E eventId(@NotNull
                 @NotNull CharSequence eventId)

Description copied from interface: Event

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

Specified by:

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

Parameters:

eventId - unique identifier to assign to this event.

Returns:

this

eventTime

public long eventTime()

Description copied from interface: Event

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.

Specified by:

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

Returns:

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

eventTime

public E eventTime(long eventTime)

Description copied from interface: Event

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.

Specified by:

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

Returns:

this

eventTimeNow

public E eventTimeNow()

Description copied from interface: Event

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.

Specified by:

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

Returns:

this

serviceId

@NotNull
public @NotNull String serviceId()

Used for cfg event routing. serviceId of the destination event

Returns:

serviceId

serviceId

public E serviceId(String serviceId)

routedTo

public boolean routedTo(String destServiceId)