Schema: MLinkSubscribeAck (ID: 3387)
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 | from MLinkSubscribe.sessionID | |
| 103 | subscribeID | long | from MLinkSubscribe.subscribeID | |
| 152 | succeeded | enum : YesNo | did the subscribe succeed? | |
| 153 | errorMsg | string(128) | if it did not succeed errorMsg will be populated | |
| 106 | numActiveSubscriptions | int | ||
| 109 | didReset | enum : YesNo | if Yes all current subscriptions were removed prior to applying the actions below |
REPEATING FIELDS
View
| # | Field | Type | Default Value | Comment |
|---|---|---|---|---|
| 115 | msgName | string(32) | a SpiderRock message name (topic channel) (can be string name or protobuf message number) | |
| 118 | view | string(128) | list (subset) of field names to return with this message type (eg. bidprice,askprice,bidsize,asksize) | |
| 121 | result | enum : SubscribeMsgResult | ||
| 124 | detail | string(32) |
Unsubscribe
| # | Field | Type | Default Value | Comment |
|---|---|---|---|---|
| 130 | msgName | string(32) | (required) a SpiderRock message name (topic channel) | |
| 133 | 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 | |
| 136 | result | enum : SubscribeMsgResult |
Subscribe
| # | Field | Type | Default Value | Comment |
|---|---|---|---|---|
| 142 | msgName | string(32) | (required) a SpiderRock message name (topic channel) | |
| 145 | msgPKey | string(128) | (required) must be an existing message.pkey; can be in either flat string or JSON format | |
| 148 | result | enum : SubscribeMsgResult | ||
| 151 | detail | string(32) |