com.marketfactory.mfapi.enterprise.api.state

Class ServerToClientSyncState

java.lang.Object

com.marketfactory.mfapi.enterprise.api.state.ServerToClientSyncState

public class ServerToClientSyncState
extends java.lang.Object

Represents state where the server needs to replay messages to us - the client. The client is caught up when the next expected sequence number matches the server's LogonResponse msgSeqNum + 1. The server will send business messages such as ExecutionReports and/or SequenceResetGapFills. To indicate this state is complete the server will send a TestRequest to which we need to send a response.

Example:

1. Client sends a Logon to server with next expected sequence number 10
2. Server sends a LogonResponse with a sequence number of 18. This means the client is missing 8 messages (with seq nums 10, 11, 12, 13, 14, 15, 16, 17)
3. Server sends a message with sequence number 10. The client validates and increments the next expected sequence number to 11.
4. Server sends a message with sequence number 11. The client validates and increments the next expected sequence number to 12.
5. Server sends a SequenceResetGapFill with sequence number 12 and a newSeqNum of 19. Notice the newSeqNum is 19 - 1 more than the sequence number of the LogonResponse seqNum.
6. Server sends a TestRequest with testRequestId AABC1 to indicate that it is finished sending messages
7. Client sends a Heartbeat with testRequestId AABC1 to indicate that it is happy server-to-client synchronization is complete.

Things to note:

• The client should disconnect if an unexpected message is received during replay - i.e. the seq number is not what is expected
• The client should handle any replayed messages - they are likely important like ExecutionReports. The list of messages that can be replayed can be found on The Lab
• The client needs to validate and increment the next expected sequence numbers

Field Summary

Fields

Modifier and Type	Field and Description
protected StateContext	context
protected static long	MAX_TRANSMISSION_DELAY_MS
protected java.lang.String	stateName

Constructor Summary

Constructors

Constructor and Description
ServerToClientSyncState(StateContext context, long serverNextExpectedMsgSeqNum, long serverLogonMsgSeqNum, boolean requiresClientToServerSynchronization)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getStateName()
void	onBusinessMessageReject(long msgSeqNum, com.marketfactory.protocol.sbe4.BusinessMessageRejectDecoder message)
void	onClientRequestedDisconnection()
void	onClientRequestedLogon()
void	onClientRequestedLogout()
void	onConnection()
void	onDisconnection()
void	onEnter()
void	onErrorReport(long msgSeqNum, com.marketfactory.protocol.sbe4.ErrorReportDecoder message)
void	onHeartbeat(long msgSeqNum, com.marketfactory.protocol.sbe4.HeartbeatDecoder message)
void	onLogonResponse(long msgSeqNum, com.marketfactory.protocol.sbe4.LogonResponseDecoder message)
void	onLogout(long msgSeqNum, com.marketfactory.protocol.sbe4.LogoutDecoder message)
void	onLogoutResponse(long msgSeqNum, com.marketfactory.protocol.sbe4.LogoutResponseDecoder message)
void	onSequenceResetGapFill(long msgSeqNum, com.marketfactory.protocol.sbe4.SequenceResetGapFillDecoder message)
void	onTestRequest(long msgSeqNum, com.marketfactory.protocol.sbe4.TestRequestDecoder message)
void	onTimer(long currentTimeMillis)
void	onUserNotification(long msgSeqNum, com.marketfactory.protocol.sbe4.UserNotificationDecoder message)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_TRANSMISSION_DELAY_MS

protected static final long MAX_TRANSMISSION_DELAY_MS

See Also:

Constant Field Values

context

protected final StateContext context

stateName

protected final java.lang.String stateName

Constructor Detail

ServerToClientSyncState

public ServerToClientSyncState(StateContext context,
                               long serverNextExpectedMsgSeqNum,
                               long serverLogonMsgSeqNum,
                               boolean requiresClientToServerSynchronization)

Method Detail

onTestRequest

public void onTestRequest(long msgSeqNum,
                          com.marketfactory.protocol.sbe4.TestRequestDecoder message)

onSequenceResetGapFill

public void onSequenceResetGapFill(long msgSeqNum,
                                   com.marketfactory.protocol.sbe4.SequenceResetGapFillDecoder message)

getStateName

public java.lang.String getStateName()

onEnter

public void onEnter()

onDisconnection

public void onDisconnection()

onConnection

public void onConnection()

onClientRequestedLogon

public void onClientRequestedLogon()

onClientRequestedLogout

public void onClientRequestedLogout()

onClientRequestedDisconnection

public void onClientRequestedDisconnection()

onTimer

public void onTimer(long currentTimeMillis)

onLogout

public void onLogout(long msgSeqNum,
                     com.marketfactory.protocol.sbe4.LogoutDecoder message)

onLogonResponse

public void onLogonResponse(long msgSeqNum,
                            com.marketfactory.protocol.sbe4.LogonResponseDecoder message)

onLogoutResponse

public void onLogoutResponse(long msgSeqNum,
                             com.marketfactory.protocol.sbe4.LogoutResponseDecoder message)

onHeartbeat

public void onHeartbeat(long msgSeqNum,
                        com.marketfactory.protocol.sbe4.HeartbeatDecoder message)

onUserNotification

public void onUserNotification(long msgSeqNum,
                               com.marketfactory.protocol.sbe4.UserNotificationDecoder message)

onBusinessMessageReject

public void onBusinessMessageReject(long msgSeqNum,
                                    com.marketfactory.protocol.sbe4.BusinessMessageRejectDecoder message)

onErrorReport

public void onErrorReport(long msgSeqNum,
                          com.marketfactory.protocol.sbe4.ErrorReportDecoder message)