Schema: MLinkSubscribe (ID: 3386)

METADATA

Attribute	Value
Topic	3325-mlink
MLink Token	MLinkWs

Note: The symbol = next to a field number indicates that it is a primary key.

BODY

#	Field	Type	Default Value	Comment
100	sessionID	short		(optional) actions below apply only to the sessionID virtual channel; should be zero for non-multiplexed web-socket connections.
103	subscribeID	long		(optional) subscribeD will be reflected back in the corresponding MLinkSubscribeAck message; nothing is assumed about structure of this number
106	activeLatency	int		(optional) number of milliseconds between active send attempts (1 = minimum delay, 0 = wait for SignalReady) [default = 0]
109	compression	enum : MLinkCompression		(optional) FieldChangesOnly will supress fields in messages that have not changed since the previous send (resets automatically after every subscription)
112	doReset	enum : YesNo		if Yes all current subscriptions will be removed prior to applying the actions below

REPEATING FIELDS

View

#	Field	Type	Default Value	Comment
118	msgName	string(32)		a SpiderRock message name (topic channel) (can be string name or protobuf message number)
121	view	string(128)		list (subset) of field names to return with this message type (eg. bidprice,askprice,bidsize,asksize)

Unsubscribe

#	Field	Type	Default Value	Comment
127	msgName	string(32)		(required) a SpiderRock message name (topic channel) (can be string name or protobuf message number)
130	msgPKey	string(128)		# an existing message.pkey; can be in either flat string or JSON format; if missing/empty all active msgName subscriptions will be removed

Subscribe

#	Field	Type	Default Value	Comment
136	msgName	string(32)		(required) a SpiderRock message name (topic channel) (can be string name or protobuf message number)
139	msgPKey	string(128)		(required) must be an existing message.pkey; can be in either flat string or JSON format
140	highwaterTs	long		(optional) records must have a header.sentTs that is later than this value (nanoseconds after the UNIX epoch) [-1 means start from current server side highwaterTs]