Page History
This page sets out the key aspects of establishing and managing sessions between a Whisperer Enterprise Client and a GatewayFeed Handler.
| Table of Contents |
|---|
Logon
A FIX session is only fully established when the following stages are complete:
...
Otherwise the Logon Service will hand off the connection to the target GatewayFeed Handler. From this point on, the Client is communicating directly with the Gateway the Feed Handler itself, neither the LogonService, nor any other processes are involved.
...
All Whisperer Enterprise messages are exchanged over TCP, with connectivity maintained directly between the Client and Gateway and Feed Handler - so message delivery and ordering are both guaranteed, whilst the socket connection is operating correctly.
...
| Info | ||
|---|---|---|
| ||
The MF Gateway MF FH guarantees persistence of sent outbound messages for possible resend for a minimum period of three heartbeat intervals, allowing for detection of dead connections as per 63805411, below. |
...
It will be noted that that all messages that represent stateful events are persisted and resent by the MF Gateway MF Feed Handler - but only these. It is the responsibility of the Client application to determine the appropriate response.
For sequence gaps identified on the outbound Client Session, it is entirely the responsibility of the Client application to determine which Optional message types are indeed to be persisted for possible resend. This is typically most important for Maker clients accepting or rejecting orders against Taker Venues, but other scenarios may need to be considered.
...
| Table Filter | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
User Session Synchronisation
...
The MFAPI Client initiates a new session with a Logon message - populating NextExpectedMsgSeqNum which contains the next msgSeqNum value that the Client expects to receive from the Whisperer GatewayFeed Handler.
The Whisperer Gateway Feed Handler validates the sequence number value as expected by the MFAPI Client as follows:
If the Client msgSeqNum is lower than the GatewayFeed Handler's expected value, or the Client is expecting a sequence number higher than the GatewayFeed Handler's next-to-be-assigned msgSeqNum, then this is an unrecoverable error and the Gateway Feed Handler will abort the session with a Logout message (using it's next sequence number).
Tip The Customer should contact MF Support to agree the correct resolution actions. - Otherwise, the Gateway the Feed Handler will issue a LogonResponse message - populating NextExpectedMsgSeqNum which contains the next msgSeqNum value that it expects to receive from the Client.
...
If the Client is expecting a sequence number lower than the GatewayFeed Handler's next-to-be-assigned msgSeqNum (as used in the preceding Logon response), then the message gap is resolved by the Gateway the Feed Handler with SequenceResetGapFill messages and/or the resending of persisted messages as necessary. The preceding LogonResponse will be gap-filled over. A concluding TestRequest will be issued by the Gateway Feed Handler to confirm the end of the replay.
Warning Should a Client specify a next-expected inbound sequence number too low (e.g. expecting '1' on re-logon just prior to weekly trading session close), then the Gateway the Feed Handler will service most of the range to correct with a SequenceResetGapFill. For the more recent messages that are still persisted, these will be processed as normal.
The Gateway The Feed Handler will not resend a week's worth of persisted messages. Refer to 63805411 above for more detail
...
- When the MFAPI Client receives the GatewayFeed Handler's LogonResponse message, the Client must behave in a similar manner, based on the returned NextExpectedMsgSeqNum value. Any message gap must be resolved by the Client with SequenceResetGapFill messages and/or the resending of persisted messages as necessary. The preceding Logon must be gap-filled over. The Gateway Feed Handler will issue a concluding TestRequest to confirm the end of the replay.
...
Irrespective of whether repays are required in either direction or not, the Gateway Feed Handler will always issue a further TestRequest to verify overall completion of the session synchronisation. Thus the Client may be expected to respond to one, two or three TestRequest messages in total to successfully Logon.
| Note | ||
|---|---|---|
| ||
Prior to Release 2020.11.16.WE, the Whisperer Enterprise Client synchronisation model mandated that the Client signal its completion of session synchronisation with a TestRequest. On receipt of this TestRequest, the Whisperer Feed Handler would respond with the necessary Heartbeat and then signal its own completion of session synchronisation with a TestRequest in the opposite direction. |
...
This is now deprecated and the Feed Handler issues all required TestRequest messages. The Client may of course elect to issue TestRequest message at any time, as part of their own session verification logic. In the sequence diagram below, the deprecated model is in red, whilst the replacement model is in green. |
| Gliffy Diagram | ||
|---|---|---|
| Gliffy Diagram | displayName | User Session Synchronziation|
|
| Warning |
|---|
The Gateway Feed Handler TestRequest messages and Client Heartbeat (response) messages are required as verification that no sequence number gaps remain in either direction. The Client should only proceed with new messages when these have been processed correctly.Any Any new (i.e. not SequenceResetGapFill or SequenceResetGapFill or resent) messages sent by the MFAPI Client prior to the required Heartbeat responses will result in ErrorReport notifications. |
...
Should the Client attempt to establish a second (additional) session using the same credentials as of a currently-active Client session, then it will be rejected. The original session will be unaffected.
| Gliffy Diagram | ||||
|---|---|---|---|---|
|
Session Monitoring
...
For inbound Heartbeat and TestRequest messages sent by the Client , the Gateway the Feed Handler will allow a fixed maximum allowed message transmission time (MaxTx), currently set to one second, before treating the message as 'missed'. This is used to allow for some degree of hysteresis WRT message delivery latencies.
The Client may specify it's own MaxTx value and logic when monitoring inbound messages sent by the GatewayFeed Handler.
In both cases only the local clock is used as reference.
...
Once the Client has successfully established a session with the Whisperer Gateway Feed Handler (i.e. on dispatch of the first Heartbeat message in response to the end of synchronisation TestRequest), subsequent Heartbeat messages are sent by each party as follows:
- The HeartBtInt value is specified by the Client in their Logon message and subsequently used by both sides of the Client Session, i.e. the Gateway the Feed Handler will always use the interval specified by the Client.
- The heartbeat interval timer should be reset after every message is transmitted (not just heartbeats).
- On expiry of the heartbeat interval timer, a Heartbeat message must be sent.
...
| Warning |
|---|
| A heartbeat is deemed to have been missed if it is not received within HeartBtInt + MaxTx seconds and must result in the monitoring party issuing a TestRequest. |
| Gliffy Diagram | displayName | 4.0 Schema_Heartbeat_3|
|---|---|---|
|
...
| Tip |
|---|
TestRequest messages may be used to obtain an approximate indication of message round-trip times between the MFAPI Client and the Whisperer GatewayFeed Handler. |
| Warning |
|---|
| If no Heartbeat response is received within HeartBtInt + MaxTx seconds of the issuance of the TestRequest, then the party must abort the session with a Logout message. |
| Gliffy Diagram | ||||
|---|---|---|---|---|
|
...
| Warning |
|---|
All messages received by the Whisperer Gateway Feed Handler (from either the Client or the Venue) between the exchange of Logout and LogoutResponse messages will result in ErrorReport messages being sent to the Client. |
...