com.dxfeed.event

Interface EventType<T>

Type Parameters:

T - type of the event symbol for this event type.

All Superinterfaces:

Serializable

All Known Subinterfaces:

IndexedEvent<T>, LastingEvent<T>, TimeSeriesEvent<T>

All Known Implementing Classes:

AnalyticOrder, Candle, Configuration, DailyCandle, Greeks, MarketEvent, Message, OptionSale, Order, OrderBase, Profile, Quote, Series, SpreadOrder, Summary, TheoPrice, TimeAndSale, Trade, TradeBase, TradeETH, Underlying

public interface EventType<T>
extends Serializable

Marks all event types that can be received via dxFeed API. Events are considered instantaneous, non-persistent, and unconflateable (each event is individually delivered) unless they implement one of interfaces defined in this package to further refine their meaning.

Event types are POJOs (plain old java objects) that follow bean naming convention with getters and setters for their properties. All event types are serializable, because they are transferred over network from publishers to data feed consumers. However, they are using custom serialization format for this purpose.

See Also:

DXFeed

Method Summary

Modifier and Type	Method and Description
T	getEventSymbol() Returns event symbol that identifies this event type in subscription.
default long	getEventTime() Returns time when event was created or zero when time is not available.
void	setEventSymbol(T eventSymbol) Changes event symbol that identifies this event type in subscription.
default void	setEventTime(long eventTime) Changes event creation time.

Method Detail

getEventSymbol

T getEventSymbol()

Returns event symbol that identifies this event type in subscription.

Returns:

event symbol.

setEventSymbol

void setEventSymbol(T eventSymbol)

Changes event symbol that identifies this event type in subscription.

Parameters:

eventSymbol - event symbol.

getEventTime

default long getEventTime()

Returns time when event was created or zero when time is not available.

This event time is available only when the corresponding DXEndpoint is created with DXENDPOINT_EVENT_TIME_PROPERTY and the data source has embedded event times. This is typically true only for data events that are read from historical tape files and from OnDemandService. Events that are coming from a network connections do not have an embedded event time information and this method will return zero for them, meaning that event was received just now.

Returns:

the difference, measured in milliseconds, between the event creation time and midnight, January 1, 1970 UTC or zero when time is not available.

Implementation Requirements:

Default implementation returns 0.

setEventTime

default void setEventTime(long eventTime)

Changes event creation time.

Parameters:

eventTime - the difference, measured in milliseconds, between the event creation time and midnight, January 1, 1970 UTC.

Implementation Requirements:

Default implementation does nothing.