Session (OnixS CME iLink3 Handler Parent 1.0.8 API)

java.lang.Object
- biz.onixs.cme.ilink3.handler.Session

```
public class Session
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static ErrorListener`	`NULL_ERROR_LISTENER`
`static InboundApplicationMessageListener`	`NULL_INBOUND_APPLICATION_MESSAGE_LISTENER`
`static InboundSessionMessageListener`	`NULL_INBOUND_SESSION_MESSAGE_LISTENER`
`static NotAppliedListener`	`NULL_NOT_APPLIED_LISTENER`
`static OutboundApplicationMessageListener`	`NULL_OUTBOUND_APPLICATION_MESSAGE_LISTENER`
`static OutboundSessionMessageListener`	`NULL_OUTBOUND_SESSION_MESSAGE_LISTENER`
`static WarningListener`	`NULL_WARNING_LISTENER`

Constructor Summary

Constructors
Constructor and Description
`Session(long uuid, SessionSettings settings)`
`Session(long uuid, SessionSettings settings, boolean cleanStart, SessionStorageType storageType)`
`Session(long uuid, SessionSettings settings, int marketSegmentId, boolean cleanStart, SessionStorageType storageType)`
`Session(SessionSettings settings)`
`Session(SessionSettings settings, int marketSegmentId)`
`Session(SessionSettings settings, int marketSegmentId, boolean cleanStart, SessionStorageType storageType)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Session`	`addStateChangeListener(StateChangeListener listener)` Adds state change listener.
`Session`	`breakConnection()` The socket is closed.
`Session`	`close()`
`ByteDecoder`	`getDecoder()` Returns SBE decoder class used by session to encode and decode SBE messages.
`ErrorListener`	`getErrorListener()` Returns error listener.
`InboundApplicationMessageListener`	`getInboundApplicationMessageListener()` Returns inbound application message listener.
`InboundSessionMessageListener`	`getInboundSessionMessageListener()` Returns inbound session message listener.
`int`	`getIncomingMessageGapQueueMaximumSize()` Returns maximum size of the incoming message gap queue.
`long`	`getInSeqNum()`
`MessageSchema`	`getMessageSchema()` Returns SBE templates description.
`NotAppliedListener`	`getNotAppliedListener()` Returns NotApplied listener.
`OutboundApplicationMessageListener`	`getOutboundApplicationMessageListener()` Returns outbound application message listener.
`List<IMessage>`	`getOutboundMessages(long beginSequenceNumber, long endSequenceNumber)` Returns outbound messages with the specified sequence number interval.
`OutboundSessionMessageListener`	`getOutboundSessionMessageListener()` Returns outbound session message listener.
`long`	`getOutSeqNum()`
`long`	`getPreviousSeqNo()`
`long`	`getPreviousUuid()`
`SessionId`	`getSessionId()`
`SessionSettings`	`getSettings()`
`SessionState`	`getState()` Returns session state.
`List<StateChangeListener>`	`getStateChangeListeners()` Returns state change listeners.
`SessionStorage`	`getStorage()` Returns session storage.
`boolean`	`getValidateSequenceNumbers()`
`WarningListener`	`getWarningListener()` Returns warning listener.
`boolean`	`isClosed()`
`boolean`	`isSkipNegotiation()` Returns whether to skip negotiation.
`Session`	`logon(String host, int port)` Establishes the connection.
`Session`	`removeStateChangeListener(StateChangeListener listener)` Removes state change listener.
`Session`	`reset(boolean startOfWeek)` Backups the current log files, resets the sequence numbers to 1 and generates a new UUID.
`Session`	`reset(boolean startOfWeek, long uuid)` Backups the current log files, resets the sequence numbers to 1 and use specified new UUID.
`Session`	`send(IMessage message)` Sends SBE message.
`Session`	`sendRetransmissionRequest(long beginSeqNumber, int numberOfMissedMsgs)` Sends the Retransmission Request message.
`Session`	`sendSequenceMessage(int keepAliveLapsed)` Send the Sequence message.
`Session`	`setErrorListener(ErrorListener listener)` Sets error listener.
`Session`	`setInboundApplicationMessageListener(InboundApplicationMessageListener listener)` Sets inbound application message listener.
`Session`	`setInboundSessionMessageListener(InboundSessionMessageListener listener)` Sets inbound session message listener.
`Session`	`setIncomingMessageGapQueueMaximumSize(int maxSize)` Sets maximum size of the incoming message gap queue.
`Session`	`setInSeqNum(long seqNum)` Sets the expected sequence number of the next incoming message.
`Session`	`setNotAppliedListener(NotAppliedListener listener)` Sets NotApplied listener.
`Session`	`setOutboundApplicationMessageListener(OutboundApplicationMessageListener listener)` Sets outbound application message listener.
`Session`	`setOutboundSessionMessageListener(OutboundSessionMessageListener listener)` Sets outbound session message listener.
`Session`	`setOutSeqNum(long seqNum)` Sets the expected sequence number of the next outgoing message.
`Session`	`setPreviousSeqNo(long seqNo)`
`Session`	`setPreviousUuid(long uuid)`
`Session`	`setSkipNegotiation(boolean negotiated)` Sets whether to skip negotiation.
`Session`	`setValidateSequenceNumbers(boolean value)`
`Session`	`setWarningListener(WarningListener listener)` Sets warning listener.
`Session`	`terminate()` Terminates the connection.
`String`	`toString()`
`Session`	`warmUp(IMessage message)` Warms up the sending path.

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

- Field Detail
  - NULL_WARNING_LISTENER
```
public static final WarningListener NULL_WARNING_LISTENER
```
  - NULL_ERROR_LISTENER
```
public static final ErrorListener NULL_ERROR_LISTENER
```
  - NULL_OUTBOUND_APPLICATION_MESSAGE_LISTENER
```
public static final OutboundApplicationMessageListener NULL_OUTBOUND_APPLICATION_MESSAGE_LISTENER
```
  - NULL_INBOUND_APPLICATION_MESSAGE_LISTENER
```
public static final InboundApplicationMessageListener NULL_INBOUND_APPLICATION_MESSAGE_LISTENER
```
  - NULL_OUTBOUND_SESSION_MESSAGE_LISTENER
```
public static final OutboundSessionMessageListener NULL_OUTBOUND_SESSION_MESSAGE_LISTENER
```
  - NULL_INBOUND_SESSION_MESSAGE_LISTENER
```
public static final InboundSessionMessageListener NULL_INBOUND_SESSION_MESSAGE_LISTENER
```
  - NULL_NOT_APPLIED_LISTENER
```
public static final NotAppliedListener NULL_NOT_APPLIED_LISTENER
```
- Constructor Detail
  - Session
```
public Session(SessionSettings settings)
```
  - Session
```
public Session(long uuid,
               SessionSettings settings)
```
  - Session
```
public Session(long uuid,
               SessionSettings settings,
               boolean cleanStart,
               SessionStorageType storageType)
```
  - Session
```
public Session(SessionSettings settings,
               int marketSegmentId)
```
  - Session
```
public Session(SessionSettings settings,
               int marketSegmentId,
               boolean cleanStart,
               SessionStorageType storageType)
```
  - Session
```
public Session(long uuid,
               SessionSettings settings,
               int marketSegmentId,
               boolean cleanStart,
               SessionStorageType storageType)
```
- Method Detail
  - logon
```
public Session logon(String host,
                     int port)
```
    Establishes the connection.
    
    Parameters:
    
    host - Market Gateway host
    
    port - Market Gateway port
    
    Returns:
    
    This session.
  - terminate
```
public Session terminate()
```
    Terminates the connection.
    
    Returns:
    
    This Session.
  - breakConnection
```
public Session breakConnection()
```
    The socket is closed. The state is changed to SessionState.TERMINATED. Breaks the FIX connection non-gracefully (without the exchange of Terminate messages).
    
    Returns:
    
    This session.
  - reset
```
public Session reset(boolean startOfWeek)
```
    Backups the current log files, resets the sequence numbers to 1 and generates a new UUID.
    Warning: Can be called only when the session is terminated.
    
    Parameters:
    
    startOfWeek - if true then the PreviousUUID and PreviousSeqNum are reset to 0.
    
    Returns:
    
    This session.
  - reset
```
public Session reset(boolean startOfWeek,
                     long uuid)
```
    Backups the current log files, resets the sequence numbers to 1 and use specified new UUID.
    Warning: Can be called only when the session is terminated.
    
    Parameters:
    
    startOfWeek - if true then the PreviousUUID and PreviousSeqNum are reset to 0.
    
    uuid - user generated UUID.
    
    Returns:
    
    This session.
  - warmUp
```
public Session warmUp(IMessage message)
```
    Warms up the sending path.
    
    Parameters:
    
    message - SBE message to warm up the sending path.
    
    Returns:
    
    This session.
  - send
```
public Session send(IMessage message)
```
    Sends SBE message.
    
    Parameters:
    
    message - SBE message.
    
    Returns:
    
    This session.
  - sendSequenceMessage
```
public Session sendSequenceMessage(int keepAliveLapsed)
```
    Send the Sequence message.
    Note: The session sends Sequence messages automatically per the CME iLink protocol. This method should be used only if an ad hoc Sequence message is required and the connection is established.
    
    Parameters:
    
    keepAliveLapsed - Indicates whether one Keep Alive interval has lapsed without any message received.
    
    Returns:
    
    This session.
  - sendRetransmissionRequest
```
public Session sendRetransmissionRequest(long beginSeqNumber,
                                         int numberOfMissedMsgs)
```
    Sends the Retransmission Request message.
    Note: Normally, "Retransmission Request" message is sent automatically. This method allows to simulate a sequence gap by sending this message manually.
    
    Parameters:
    
    beginSeqNumber - begin sequence number of the first requested message in the range.
    
    numberOfMissedMsgs - the number of messages to be requested.
    
    Returns:
    
    This session.
    
    Throws:
    
    IllegalArgumentException - if (beginSeqNumber + numberOfMissedMsgs > inSeqNum) or if (numberOfMissedMsgs <= 0)
  - getSessionId
```
public SessionId getSessionId()
```
  - getSettings
```
public SessionSettings getSettings()
```
  - getState
```
public SessionState getState()
```
    Returns session state.
    
    Returns:
    
    session state
  - getDecoder
```
public ByteDecoder getDecoder()
```
    Returns SBE decoder class used by session to encode and decode SBE messages. This class is not thread safe.
    
    Returns:
    
    SBE decoder class
  - getMessageSchema
```
public MessageSchema getMessageSchema()
```
    Returns SBE templates description.
    
    Returns:
    
    SBE templates description
  - getStorage
```
public SessionStorage getStorage()
```
    Returns session storage.
    
    Returns:
    
    session storage
  - getOutboundApplicationMessageListener
```
public OutboundApplicationMessageListener getOutboundApplicationMessageListener()
```
    Returns outbound application message listener.
    
    Returns:
    
    outbound application message listener
  - setOutboundApplicationMessageListener
```
public Session setOutboundApplicationMessageListener(OutboundApplicationMessageListener listener)
```
    Sets outbound application message listener. Warning. This is critical to avoid time-consuming tasks inside the listener.
    
    Parameters:
    
    listener - outbound application message listener or NULL_OUTBOUND_APPLICATION_MESSAGE_LISTENER value to reset listener to default
    
    Returns:
    
    This session.
  - getInboundApplicationMessageListener
```
public InboundApplicationMessageListener getInboundApplicationMessageListener()
```
    Returns inbound application message listener.
    
    Returns:
    
    inbound application message listener
  - setInboundApplicationMessageListener
```
public Session setInboundApplicationMessageListener(InboundApplicationMessageListener listener)
```
    Sets inbound application message listener. Warning. This is critical to avoid time-consuming tasks inside the listener.
    
    Parameters:
    
    listener - inbound application message listener or NULL_INBOUND_APPLICATION_MESSAGE_LISTENER value to reset listener to default
    
    Returns:
    
    This session.
  - getOutboundSessionMessageListener
```
public OutboundSessionMessageListener getOutboundSessionMessageListener()
```
    Returns outbound session message listener.
    
    Returns:
    
    outbound session message listener
  - setOutboundSessionMessageListener
```
public Session setOutboundSessionMessageListener(OutboundSessionMessageListener listener)
```
    Sets outbound session message listener. Warning. This is critical to avoid time-consuming tasks inside the listener.
    
    Parameters:
    
    listener - outbound session message listener or NULL_OUTBOUND_SESSION_MESSAGE_LISTENER value to reset listener to default
    
    Returns:
    
    This session.
  - getInboundSessionMessageListener
```
public InboundSessionMessageListener getInboundSessionMessageListener()
```
    Returns inbound session message listener.
    
    Returns:
    
    inbound session message listener
  - setInboundSessionMessageListener
```
public Session setInboundSessionMessageListener(InboundSessionMessageListener listener)
```
    Sets inbound session message listener. Warning. This is critical to avoid time-consuming tasks inside the listener.
    
    Parameters:
    
    listener - inbound session message listener or NULL_INBOUND_SESSION_MESSAGE_LISTENER value to reset listener to default
    
    Returns:
    
    This session.
  - getNotAppliedListener
```
public NotAppliedListener getNotAppliedListener()
```
    Returns NotApplied listener.
    
    Returns:
    
    NotApplied listener
  - setNotAppliedListener
```
public Session setNotAppliedListener(NotAppliedListener listener)
```
    Sets NotApplied listener. Warning. This is critical to avoid time-consuming tasks inside the listener.
    
    Parameters:
    
    listener - NotApplied listener or NULL_NOT_APPLIED_LISTENER value to reset listener to default
    
    Returns:
    
    This session.
  - getErrorListener
```
public ErrorListener getErrorListener()
```
    Returns error listener.
    
    Returns:
    
    error listener
  - setErrorListener
```
public Session setErrorListener(ErrorListener listener)
```
    Sets error listener. Warning. This is critical to avoid time-consuming tasks inside the listener.
    
    Parameters:
    
    listener - error listener or NULL_ERROR_LISTENER value to reset listener to default
    
    Returns:
    
    This session.
  - getWarningListener
```
public WarningListener getWarningListener()
```
    Returns warning listener.
    
    Returns:
    
    warning listener
  - setWarningListener
```
public Session setWarningListener(WarningListener listener)
```
    Sets warning listener. Warning. This is critical to avoid time-consuming tasks inside the listener.
    
    Parameters:
    
    listener - warning listener or NULL_WARNING_LISTENER value to reset listener to default
    
    Returns:
    
    This session.
  - getStateChangeListeners
```
public List<StateChangeListener> getStateChangeListeners()
```
    Returns state change listeners.
    
    Returns:
    
    state change listeners.
  - addStateChangeListener
```
public Session addStateChangeListener(StateChangeListener listener)
```
    Adds state change listener. Warning. This is critical to avoid time-consuming tasks inside the listener.
    
    Parameters:
    
    listener - state change listener
    
    Returns:
    
    This session.
  - removeStateChangeListener
```
public Session removeStateChangeListener(StateChangeListener listener)
```
    Removes state change listener.
    
    Parameters:
    
    listener - state change listener
    
    Returns:
    
    This session.
  - close
```
public Session close()
```
  - isClosed
```
public boolean isClosed()
```
  - isSkipNegotiation
```
public boolean isSkipNegotiation()
```
    Returns whether to skip negotiation.
    
    Returns:
    
    true if the session is negotiated and it will be skipped (the Negotiation Response message has been received in reply to the Negotiation message), otherwise - false.
  - setSkipNegotiation
```
public Session setSkipNegotiation(boolean negotiated)
```
    Sets whether to skip negotiation.
    The session is negotiated when the Negotiation Response message has been received in reply to the Negotiation message.
    
    Parameters:
    
    negotiated - true if the session is negotiated and it will be skipped, otherwise - false.
    
    Returns:
    
    This session.
  - getInSeqNum
```
public long getInSeqNum()
```
  - setInSeqNum
```
public Session setInSeqNum(long seqNum)
```
    Sets the expected sequence number of the next incoming message.
    
    Parameters:
    
    seqNum - sequence number
    
    Returns:
    
    This session.
  - getOutSeqNum
```
public long getOutSeqNum()
```
  - setOutSeqNum
```
public Session setOutSeqNum(long seqNum)
```
    Sets the expected sequence number of the next outgoing message.
    
    Parameters:
    
    seqNum - sequence number
    
    Returns:
    
    This session.
  - getPreviousSeqNo
```
public long getPreviousSeqNo()
```
  - setPreviousSeqNo
```
public Session setPreviousSeqNo(long seqNo)
```
  - getPreviousUuid
```
public long getPreviousUuid()
```
  - setPreviousUuid
```
public Session setPreviousUuid(long uuid)
```
  - getIncomingMessageGapQueueMaximumSize
```
public int getIncomingMessageGapQueueMaximumSize()
```
    Returns maximum size of the incoming message gap queue.
    
    Returns:
    
    maximum size of the incoming message gap queue.
  - setIncomingMessageGapQueueMaximumSize
```
public Session setIncomingMessageGapQueueMaximumSize(int maxSize)
```
    Sets maximum size of the incoming message gap queue.
    
    Parameters:
    
    maxSize - maximum size of the incoming message gap queue
    
    Returns:
    
    this.
  - getOutboundMessages
```
public List<IMessage> getOutboundMessages(long beginSequenceNumber,
                                          long endSequenceNumber)
```
    Returns outbound messages with the specified sequence number interval. Ends are included.
    
    Parameters:
    
    beginSequenceNumber - sequence number to begin with
    
    endSequenceNumber - sequence number to end with
    
    Returns:
    
    outbound messages
    
    Throws:
    
    IllegalArgumentException - if (beginSeqNum < 1)
  - getValidateSequenceNumbers
```
public boolean getValidateSequenceNumbers()
```
  - setValidateSequenceNumbers
```
public Session setValidateSequenceNumbers(boolean value)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Session

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL_WARNING_LISTENER

NULL_ERROR_LISTENER

NULL_OUTBOUND_APPLICATION_MESSAGE_LISTENER

NULL_INBOUND_APPLICATION_MESSAGE_LISTENER

NULL_OUTBOUND_SESSION_MESSAGE_LISTENER

NULL_INBOUND_SESSION_MESSAGE_LISTENER

NULL_NOT_APPLIED_LISTENER

Constructor Detail

Session

Session

Session

Session

Session

Session

Method Detail

logon

terminate

breakConnection

reset

reset

warmUp

send

sendSequenceMessage

sendRetransmissionRequest

getSessionId

getSettings

getState

getDecoder

getMessageSchema

getStorage

getOutboundApplicationMessageListener

setOutboundApplicationMessageListener

getInboundApplicationMessageListener

setInboundApplicationMessageListener

getOutboundSessionMessageListener

setOutboundSessionMessageListener

getInboundSessionMessageListener

setInboundSessionMessageListener

getNotAppliedListener

setNotAppliedListener

getErrorListener

setErrorListener

getWarningListener

setWarningListener

getStateChangeListeners

addStateChangeListener

removeStateChangeListener

close

isClosed

isSkipNegotiation

setSkipNegotiation

getInSeqNum

setInSeqNum

getOutSeqNum

setOutSeqNum

getPreviousSeqNo

setPreviousSeqNo

getPreviousUuid

setPreviousUuid

getIncomingMessageGapQueueMaximumSize

setIncomingMessageGapQueueMaximumSize

getOutboundMessages

getValidateSequenceNumbers

setValidateSequenceNumbers

toString