Session Class |
FIX Session.
Inheritance HierarchyNamespace: com.b2bits.FIXAntenna
Assembly: FIXAntenna_net4.8 (in FIXAntenna_net4.8.dll) Version: 2.32.0.0
SyntaxThe Session type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AppVersion | Returns the FIX Application level protocol base version. |
| Encryption | Returns the encryption method. |
| HeartBtInt | Returns Heartbeat interval (HeartBtInt) in seconds. |
| InSeqNum | Returns the incoming sequence numbers for this FIX session (the expected MsgSeqNum of the next incoming message). |
| IsSSL | Returns true if SSL Context created for session. |
| OutSeqNum | Returns the outgoing sequence numbers for this FIX session. (MsgSeqNum of the next outgoing message). |
| ParserID | Returns unique parser identifier of the session. |
| ProtocolID | Returns unique parser identifier of the session. deprecated, use ParserID |
| RemoteHost | Returns the remote FIX Engine's host name. |
| RemoteHostIP | Returns the remote FIX Engine's host name. |
| RemotePort | Returns the remote FIX Engine's port number. |
| Role | Returns session's role. |
| SenderCompID | Returns SenderCompID |
| SenderSubID | Returns SenderSubID. |
| SessionID | Returns Session Identifier. |
| State | Returns session's state; |
| StorageCreationTime | Returns storage creation UTC time. If no storage is assigned with Session, method returns 0 |
| TargetCompID | Returns TargetCompID. |
| TargetSubID | Returns TargetSubID. |
| Version | Returns the FIX protocol version. |
Methods| Name | Description | |
|---|---|---|
 | Connect | Establishes the FIX session. |
| ConnectAsAcceptor | Establishes the FIX session as Acceptor. |
| ConnectAsInitiator(String, Int32, Int32) | Establishes the FIX session as Initiator. |
| ConnectAsInitiator(String, Int32, Int32, FixMessage) | Establishes the FIX session as Initiator using the custom Logon message. |
| CreateMessage(String) | Creates new FixMessage |
| CreateMessage(String, FixVersion) | Creates new FixMessage |
| Disconnect | Closes the session. |
| Disconnect(Boolean) | Closes session. |
| Disconnect(String, Boolean) | Closes session with the given logout text. |
| DisconnectNonGracefully | Closes the telecommunication link and switches the session into the NON_GRACEFULLY_TERMINATED state. |
| DisconnectSync | Closes the session synchronously. |
| DisconnectSync(Boolean) | Closes session synchronously. |
| DisconnectSync(String, Boolean) | Synchronously closes session with the given logout text. |
| Dispose | Releases all resources used by the Session |
 | Dispose(Boolean) | Releases the unmanaged resources used by the Session and optionally releases the managed resources |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | (Overrides ObjectFinalize) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetReceivedMessages | |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Inflate(FixMessage, Int32) | Sets static session level fields in the message and reserves space for volatile session level fields. |
| Inflate(FixMessage, Int32, PutMessageOptions) | Sets static session level fields in the message and reserves space for volatile session level fields. |
| IsDisposed | Checks if Session is disposed (whether Dispose() was called or not). If session is disposed then although the object exists all it's component are destroyed. So further working with it may cause failure. |
| LocateSentMessage | Restores sent message by given message sequence number. If message is not found, method returns . |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Ping | Sends the Test Request message. |
| Ping(String) | Sends the Test Request message with the given TestReqID. |
| Put(FixMessage) | Sends the given message to the remote FIX engine. After method is return, message can be destroyed by user. |
| Put(PreparedMessage) | Sends the given message to the remote FIX engine. After method is return, message can be destroyed by user. |
| Put(FixMessage, PutMessageOptions) | Sends the given message to the remote FIX engine. After method is return, message can be destroyed by user. |
| ResetSeqNum | Sends the Logon message with the ResetSeqNumFlag flag that indicates both sides of a FIX session should reset sequence numbers. |
| ResetSeqNum(SeqNumResetStrategy) | Sends the Logon message with the ResetSeqNumFlag flag that indicates both sides of a FIX session should reset sequence numbers. |
| ToString |
Returns string representation.
(Overrides ObjectToString) |
Events| Name | Description | |
|---|---|---|
 | AfterMessageIsParsedEvent | Fired after incoming message is parsed and stored in storage. Before any message validation. |
| AfterMessageIsReceivedEvent | Occurs when the incoming message is just received from the wire. |
| BeforeMessageIsSentEvent | Occurs when the incoming message is about to be sent to the wire. |
| BeforeMessageIsSerializedEvent | Fired after outgoing message is validated and before it is stored in the storage and sent to socket. |
| HeartbeatWithTestReqIDEvent | Occurs when a Heartbeat message (MsgType = 0) with the TestReqID field (tag = 112) has been received. |
| IncomingMessageEvent | Occurs when the incoming messages received. |
| InvalidResendRequestEvent | Occurs when a ill-formed Resend Request (MsgType = 2) has been received. |
| LogonEvent | Occurs when the Logon message has been received from the counterpart. |
| LogoutEvent | Occurs when the Logout message has been received from the counterpart or the session was disconnected. |
| MsgRejectEvent | Occurs when a message have to be rejected. |
| NewStateEvent | Occurs when the session has changed its state. |
| ReconnectTryEvent | This call-back method is called each time session tries to reconnect. |
| ResendEvent | Occurs when an outgoing message is about to be resent as a reply to the incoming ResendRequest message. |
| ResendRequestEvent | Occurs when a Resend Request (MsgType = 2) has been received. |
| ResendRequestLoopEvent | This call-back method is called when #DuplicateResendRequestLimit ResendRequest messages are received. |
| SequenceGapEvent | Occurs when a message gap is detected in incoming messages. |
| SessionLevelRejectEvent | Occurs when a session-level Reject message (MsgType = 3) is received. |
| SessionLevelRejectWithSeqNumTooHighEvent | Fired when Session Level Reject message is received with the sequence number too high. If message is processed, user should set IncomingMessageEventHandler.Processed = true. In this case Resend Request message will not be sent. |
| UnableToRouteMessageEvent | Occurs when the message has to be routed to the session, which does not exist. |
| UnexpectedMessageEvent | Occurs when unexpected message is received. For example - when first message in session is not a Logon. |
See Also