Package velox.api.layer1.reading

Class UserDataUserMessage

java.lang.Object

velox.api.layer1.reading.UserDataUserMessage

All Implemented Interfaces:

velox.api.layer1.messages.Layer1ApiIgnorableUpwardMessage

public class UserDataUserMessage
extends Object
implements velox.api.layer1.messages.Layer1ApiIgnorableUpwardMessage

This class is used for sending arbitrary user data and storing it into feeds/historical data.

Messages with alias != null will be stored as instrument specific events and will be available both in replay and historical data.

Messages with alias == null will be stored as global events and will be available only in replay. Currently such messages are not stored in historical data.

You can use custom generators to get data from these messages stored in historical data/trees. See an example in UserDataUserMessageDemo from the DemoStrategies repo.

Field Summary

Fields

Modifier and Type	Field	Description
final String	alias
final byte[]	data
final String	tag

Constructor Summary

Constructors

Constructor	Description
UserDataUserMessage(String tag, String alias, byte[] data)

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

tag

public final String tag

alias

public final String alias

data

public final byte[] data

Constructor Details

UserDataUserMessage

public UserDataUserMessage(String tag,
 String alias,
 byte[] data)