SessionState (QuickFIX/J Distribution 2.3.0 API)

java.lang.Object
- quickfix.SessionState

```
public final class SessionState
extends Object
```
Used by the session communications code. Not intended to be used by applications. All dynamic data is protected by the session's intrinsic lock. The log and message store implementation must be thread safe.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SessionState.ResendRange
The resend range when sending a resend request.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SessionState.ResendRange` The resend range when sending a resend request.

Constructor Summary

Constructors
Constructor and Description
`SessionState(Object lock, Log log, int heartBeatInterval, boolean initiator, MessageStore messageStore, double testRequestDelayMultiplier, double heartBeatTimeoutMultiplier)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearLogoutReason()`
`void`	`clearQueue()`
`void`	`clearTestRequestCounter()`
`Message`	`dequeue(int sequence)`
`void`	`dequeueMessagesUpTo(int seqnum)` Remove messages from messageQueue up to a given sequence number.
`void`	`enqueue(int sequence, Message message)`
`void`	`get(int first, int last, Collection<String> messages)`
`Date`	`getCreationTime()`
`int`	`getHeartBeatInterval()`
`int`	`getLastExpectedLogonNextSeqNum()`
`long`	`getLastReceivedTime()`
`long`	`getLastSentTime()`
`Object`	`getLock()`
`Log`	`getLog()`
`int`	`getLogonTimeout()`
`String`	`getLogoutReason()`
`int`	`getLogoutTimeout()`
`MessageStore`	`getMessageStore()`
`Message`	`getNextQueuedMessage()`
`int`	`getNextSenderMsgSeqNum()`
`int`	`getNextTargetMsgSeqNum()`
`Collection<Integer>`	`getQueuedSeqNums()`
`SessionState.ResendRange`	`getResendRange()`
`double`	`getTestRequestDelayMultiplier()`
`void`	`incrementTestRequestCounter()`
`void`	`incrNextSenderMsgSeqNum()`
`void`	`incrNextTargetMsgSeqNum()`
`boolean`	`isExpectedLogonNextSeqNumSent()`
`boolean`	`isHeartBeatNeeded()`
`boolean`	`isInitiator()`
`boolean`	`isLogonAlreadySent()`
`boolean`	`isLogonReceived()`
`boolean`	`isLogonSendNeeded()`
`boolean`	`isLogonSent()`
`boolean`	`isLogonTimedOut()`
`boolean`	`isLogoutReceived()`
`boolean`	`isLogoutSent()`
`boolean`	`isLogoutTimedOut()`
`boolean`	`isResendRequested()`
`boolean`	`isResetNeeded()`
`boolean`	`isResetReceived()`
`boolean`	`isResetSent()`
`boolean`	`isResetStatePending()`
`boolean`	`isTestRequestNeeded()`
`boolean`	`isTimedOut()`
`void`	`lockSenderMsgSeqNum()`
`void`	`lockTargetMsgSeqNum()`
`void`	`reset()`
`boolean`	`set(int sequence, String message)`
`void`	`setHeartBeatInterval(int heartBeatInterval)`
`void`	`setLastExpectedLogonNextSeqNum(int lastExpectedLogonNextSeqNum)`
`void`	`setLastReceivedTime(long lastReceivedTime)`
`void`	`setLastSentTime(long lastSentTime)`
`void`	`setLogonReceived(boolean logonReceived)`
`void`	`setLogonSent(boolean logonSent)`
`void`	`setLogonTimeout(int logonTimeout)`
`void`	`setLogoutReason(String reason)`
`void`	`setLogoutReceived(boolean logoutReceived)`
`void`	`setLogoutSent(boolean logoutSent)`
`void`	`setLogoutTimeout(int logoutTimeout)`
`void`	`setNextTargetMsgSeqNum(int sequence)`
`void`	`setResendRange(int low, int high)`
`void`	`setResendRange(int low, int high, int currentResend)`
`void`	`setResetRangeFromLastExpectedLogonNextSeqNumLogon()` No actual resend request has occurred but at logon we populated tag 789 so that the other side knows we are missing messages without an explicit resend request and should immediately reply with the missing messages.
`void`	`setResetReceived(boolean resetReceived)`
`void`	`setResetSent(boolean resetSent)`
`void`	`setResetStatePending(boolean resetStatePending)`
`void`	`unlockSenderMsgSeqNum()`
`void`	`unlockTargetMsgSeqNum()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SessionState

public SessionState(Object lock,
                    Log log,
                    int heartBeatInterval,
                    boolean initiator,
                    MessageStore messageStore,
                    double testRequestDelayMultiplier,
                    double heartBeatTimeoutMultiplier)

Method Detail

getHeartBeatInterval
```
public int getHeartBeatInterval()
```

setHeartBeatInterval

public void setHeartBeatInterval(int heartBeatInterval)

isHeartBeatNeeded
```
public boolean isHeartBeatNeeded()
```

isInitiator
```
public boolean isInitiator()
```

getLastReceivedTime
```
public long getLastReceivedTime()
```

setLastReceivedTime

public void setLastReceivedTime(long lastReceivedTime)

getLastSentTime
```
public long getLastSentTime()
```

setLastSentTime

public void setLastSentTime(long lastSentTime)

getLog
```
public Log getLog()
```

isLogonAlreadySent
```
public boolean isLogonAlreadySent()
```

isLogonReceived
```
public boolean isLogonReceived()
```

setLogonReceived

public void setLogonReceived(boolean logonReceived)

isLogonSendNeeded
```
public boolean isLogonSendNeeded()
```

isLogonSent
```
public boolean isLogonSent()
```

setLogonSent

public void setLogonSent(boolean logonSent)

isLogonTimedOut
```
public boolean isLogonTimedOut()
```

setLogonTimeout

public void setLogonTimeout(int logonTimeout)

getLogonTimeout
```
public int getLogonTimeout()
```

setLogoutTimeout

public void setLogoutTimeout(int logoutTimeout)

getLogoutTimeout
```
public int getLogoutTimeout()
```

isLogoutSent
```
public boolean isLogoutSent()
```

setLogoutSent

public void setLogoutSent(boolean logoutSent)

isLogoutReceived
```
public boolean isLogoutReceived()
```

setLogoutReceived

public void setLogoutReceived(boolean logoutReceived)

isLogoutTimedOut
```
public boolean isLogoutTimedOut()
```

getMessageStore
```
public MessageStore getMessageStore()
```

getTestRequestDelayMultiplier

public double getTestRequestDelayMultiplier()

clearTestRequestCounter
```
public void clearTestRequestCounter()
```

incrementTestRequestCounter

public void incrementTestRequestCounter()

isTestRequestNeeded
```
public boolean isTestRequestNeeded()
```

isTimedOut
```
public boolean isTimedOut()
```

set

public boolean set(int sequence,
                   String message)
            throws IOException

Throws:: IOException

get

public void get(int first,
                int last,
                Collection<String> messages)
         throws IOException

Throws:: IOException

enqueue

public void enqueue(int sequence,
                    Message message)

dequeue
```
public Message dequeue(int sequence)
```

dequeueMessagesUpTo
```
public void dequeueMessagesUpTo(int seqnum)
```
Remove messages from messageQueue up to a given sequence number.

Parameters:

seqnum - up to which sequence number messages should be deleted

getNextQueuedMessage
```
public Message getNextQueuedMessage()
```

getQueuedSeqNums

public Collection<Integer> getQueuedSeqNums()

clearQueue
```
public void clearQueue()
```

lockSenderMsgSeqNum
```
public void lockSenderMsgSeqNum()
```

unlockSenderMsgSeqNum
```
public void unlockSenderMsgSeqNum()
```

lockTargetMsgSeqNum
```
public void lockTargetMsgSeqNum()
```

unlockTargetMsgSeqNum
```
public void unlockTargetMsgSeqNum()
```

getNextSenderMsgSeqNum

public int getNextSenderMsgSeqNum()
                           throws IOException

Throws:: IOException

getNextTargetMsgSeqNum

public int getNextTargetMsgSeqNum()
                           throws IOException

Throws:: IOException

setNextTargetMsgSeqNum

public void setNextTargetMsgSeqNum(int sequence)
                            throws IOException

Throws:: IOException

incrNextSenderMsgSeqNum

public void incrNextSenderMsgSeqNum()
                             throws IOException

Throws:: IOException

incrNextTargetMsgSeqNum

public void incrNextTargetMsgSeqNum()
                             throws IOException

Throws:: IOException

getCreationTime

public Date getCreationTime()
                     throws IOException

Throws:: IOException

isResetNeeded

public boolean isResetNeeded()
                      throws IOException

Throws:: IOException

reset
```
public void reset()
```

setResendRange

public void setResendRange(int low,
                           int high)

setResendRange

public void setResendRange(int low,
                           int high,
                           int currentResend)

isResendRequested
```
public boolean isResendRequested()
```

getResendRange

public SessionState.ResendRange getResendRange()

isResetReceived
```
public boolean isResetReceived()
```

setResetReceived

public void setResetReceived(boolean resetReceived)

isResetSent
```
public boolean isResetSent()
```

setResetSent

public void setResetSent(boolean resetSent)

isResetStatePending
```
public boolean isResetStatePending()
```

setResetStatePending

public void setResetStatePending(boolean resetStatePending)

setResetRangeFromLastExpectedLogonNextSeqNumLogon
```
public void setResetRangeFromLastExpectedLogonNextSeqNumLogon()
```
No actual resend request has occurred but at logon we populated tag 789 so that the other side knows we are missing messages without an explicit resend request and should immediately reply with the missing messages. This is expected to be called only in the scenario where target is too high on logon and tag 789 is supported.

setLastExpectedLogonNextSeqNum
```
public void setLastExpectedLogonNextSeqNum(int lastExpectedLogonNextSeqNum)
```
Parameters:

lastExpectedLogonNextSeqNum - This method is thread safe (atomic set).

getLastExpectedLogonNextSeqNum
```
public int getLastExpectedLogonNextSeqNum()
```
Returns:

nextExpectedMsgSeqNum This method is thread safe (atomic get).

isExpectedLogonNextSeqNumSent
```
public boolean isExpectedLogonNextSeqNumSent()
```
Returns:

true if we populated tag 789 at logon and our sequence numbers don't line up we are in an implicit resend mode. This method is thread safe (atomic get).

setLogoutReason

public void setLogoutReason(String reason)

getLogoutReason
```
public String getLogoutReason()
```

clearLogoutReason
```
public void clearLogoutReason()
```

getLock
```
public Object getLock()
```

Class SessionState

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SessionState

Method Detail

getHeartBeatInterval

setHeartBeatInterval

isHeartBeatNeeded

isInitiator

getLastReceivedTime

setLastReceivedTime

getLastSentTime

setLastSentTime

getLog

isLogonAlreadySent

isLogonReceived

setLogonReceived

isLogonSendNeeded

isLogonSent

setLogonSent

isLogonTimedOut

setLogonTimeout

getLogonTimeout

setLogoutTimeout

getLogoutTimeout

isLogoutSent

setLogoutSent

isLogoutReceived

setLogoutReceived

isLogoutTimedOut

getMessageStore

getTestRequestDelayMultiplier

clearTestRequestCounter

incrementTestRequestCounter

isTestRequestNeeded

isTimedOut

set

get

enqueue

dequeue

dequeueMessagesUpTo

getNextQueuedMessage

getQueuedSeqNums

clearQueue

lockSenderMsgSeqNum

unlockSenderMsgSeqNum

lockTargetMsgSeqNum

unlockTargetMsgSeqNum

getNextSenderMsgSeqNum

getNextTargetMsgSeqNum

setNextTargetMsgSeqNum

incrNextSenderMsgSeqNum

incrNextTargetMsgSeqNum

getCreationTime

isResetNeeded

reset

setResendRange

setResendRange

isResendRequested

getResendRange

isResetReceived

setResetReceived

isResetSent

setResetSent

isResetStatePending

setResetStatePending

setResetRangeFromLastExpectedLogonNextSeqNumLogon

setLastExpectedLogonNextSeqNum

getLastExpectedLogonNextSeqNum

isExpectedLogonNextSeqNumSent

setLogoutReason

getLogoutReason

clearLogoutReason

getLock