com.dxfeed.event.misc

Class TextMessage

java.lang.Object

com.dxfeed.event.misc.TextMessage

All Implemented Interfaces:

EventType<String>, Serializable

public class TextMessage
extends Object
implements EventType<String>

Message event with text payload. Messages are never conflated and are delivered to all connected subscribers. There is no built-in persistence for messages. They are lost when subscribers are not connected to the message publisher, so they shall be only used for notification purposes in addition to persistence mechanism.

Properties

TextMessage event has the following properties:

• eventSymbol - symbol of this event;
• time - time of the text message;
• sequence - sequence of the text message;
• text - text payload.

Implementation details

This event is implemented on top of QDS record TextMessage.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_SEQUENCE Maximum allowed sequence value.

Constructor Summary

Constructors

Constructor and Description
TextMessage() Creates new message with default values.
TextMessage(String eventSymbol) Creates new message with the specified event symbol.
TextMessage(String eventSymbol, long time, String text) Creates new message with the specified event symbol, time and text.
TextMessage(String eventSymbol, String text) Creates new message with the specified event symbol and text.

Method Summary

Modifier and Type	Method and Description
String	getEventSymbol() Returns symbol for this event.
long	getEventTime() Returns time when event was created or zero when time is not available.
int	getSequence() Returns sequence number of the text message to distinguish messages that have the same time.
String	getText() Returns text.
long	getTime() Returns time of the text message.
long	getTimeSequence() Returns time and sequence of text message packaged into single long value.
void	setEventSymbol(String eventSymbol) Changes symbol for this event.
void	setEventTime(long eventTime) Changes event creation time.
void	setSequence(int sequence) Changes getSequence() sequence number of the text message.
void	setText(String text) Changes text.
void	setTime(long time) Changes time of the text message.
void	setTimeSequence(long timeSequence) Changes time and sequence of text message.
String	toString() Returns string representation of this TextMessage event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MAX_SEQUENCE

public static final int MAX_SEQUENCE

Maximum allowed sequence value.

See Also:

setSequence(int), Constant Field Values

Constructor Detail

TextMessage

public TextMessage()

Creates new message with default values.

TextMessage

public TextMessage(String eventSymbol)

Creates new message with the specified event symbol.

Parameters:

eventSymbol - event symbol.

TextMessage

public TextMessage(String eventSymbol,
                   String text)

Creates new message with the specified event symbol and text.

Parameters:

eventSymbol - event symbol.

text - text.

TextMessage

public TextMessage(String eventSymbol,
                   long time,
                   String text)

Creates new message with the specified event symbol, time and text.

Parameters:

eventSymbol - event symbol.

time - time.

text - text.

Method Detail

getEventSymbol

public String getEventSymbol()

Returns symbol for this event.

Specified by:

getEventSymbol in interface EventType<String>

Returns:

event symbol.

setEventSymbol

public void setEventSymbol(String eventSymbol)

Changes symbol for this event.

Specified by:

setEventSymbol in interface EventType<String>

Parameters:

eventSymbol - event symbol.

getEventTime

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

Specified by:

getEventTime in interface EventType<String>

Returns:

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

setEventTime

public void setEventTime(long eventTime)

Changes event creation time.

Specified by:

setEventTime in interface EventType<String>

Parameters:

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

getTimeSequence

public long getTimeSequence()

Returns time and sequence of text message packaged into single long value.

Returns:

time and sequence of text message.

setTimeSequence

public void setTimeSequence(long timeSequence)

Changes time and sequence of text message. Do not use this method directly. Change time and/or sequence.

Parameters:

timeSequence - the time and sequence.

See Also:

getTimeSequence()

getTime

public long getTime()

Returns time of the text message. Time is measured in milliseconds between the current time and midnight, January 1, 1970 UTC.

Returns:

time of the text message.

setTime

public void setTime(long time)

Changes time of the text message. Time is measured in milliseconds between the current time and midnight, January 1, 1970 UTC.

Parameters:

time - time of the text message.

getSequence

public int getSequence()

Returns sequence number of the text message to distinguish messages that have the same time. This sequence number does not have to be unique and does not need to be sequential. Sequence can range from 0 to MAX_SEQUENCE.

Returns:

sequence of the text message.

setSequence

public void setSequence(int sequence)

Changes getSequence() sequence number of the text message.

Parameters:

sequence - the sequence.

Throws:

IllegalArgumentException - if sequence is below zero or above MAX_SEQUENCE.

See Also:

getSequence()

getText

public String getText()

Returns text.

setText

public void setText(String text)

Changes text.

Parameters:

text - text.

toString

public String toString()

Returns string representation of this TextMessage event.

Overrides:

toString in class Object