FixEngine ClassFIX Antenna .NET Programmer's Guide
FIX Engine. This class is responsible for: initialization, creating sessions and obtaining state information.
Inheritance Hierarchy

SystemObject
  com.b2bits.FIXAntennaFixEngine

Namespace: com.b2bits.FIXAntenna
Assembly: FIXAntenna_net4.0 (in FIXAntenna_net4.0.dll) Version: 2.27.0.0
Syntax

public sealed class FixEngine : IDisposable

The FixEngine type exposes the following members.

Methods

  NameDescription
Public methodBackupLogFile
Backups engine's log file under the given name and opens a new one.
Public methodStatic memberClearAdditionalFields
Destroys the additional fields.
Public methodStatic memberCreate
Initializes the FixEngine using default settings.
Public methodStatic memberCreate(String)
Initializes the FixEngine using property file.
Public methodStatic memberCreate(FixEngineStartupParams)
Initializes the FixEngine using startup parameters.
Public methodStatic memberCreate(String, String)
Initializes the FixEngine using property file and additional fields.
Public methodCreateFastSession(SessionId, FixVersion, String)
Creates a new FIX Session with given Session Id.
Public methodCreateFastSession(String, String, FixVersion, String)
Creates a new FIX Session.
Public methodCreateFastSession(SessionId, FixVersion, SessionExtraParameters, String)
Creates a new FIX Session with given Session Id using extra parameters.
Public methodCreateFastSession(String, String, FixVersion, SessionExtraParameters, String)
Creates a new FIX Session using extra parameters.
Public methodCreateFastSession(SessionId, FixVersion, SessionExtraParameters, MessageStorageType, String)
Creates a new FIX Session with given Session Id using extra parameters.
Public methodCreateFastSession(String, String, FixVersion, SessionExtraParameters, MessageStorageType, String)
Creates a new FIX Session using extra parameters.
Public methodCreateFixParser(String, DictionaryFixVersion, String)
Public methodCreateFixParser(String, String, DictionaryFixVersion, String)
Public methodCreateMDApplication(MDAppParams)
Creates a new CME MDApplication
Public methodCreateMDApplication(MDAppParams, MDApplicationListener)
Creates a new CME MDApplication
Public methodCreateMDApplication(MDAppParams, MockDataPublisher)
Creates a new CME MDApplication
Public methodCreateMDApplication(MDAppParams, MDApplicationListener, MockDataPublisher)
Creates a new CME MDApplication
Public methodCreateProtocol
Register new custom FIX Protocol and returns its identifier
Public methodCreateSession(SessionId, FixVersion)
Creates a new FIX Session with given Session Id.
Public methodCreateSession(String, String, FixVersion)
Creates a new FIX Session.
Public methodCreateSession(SessionId, FixVersion, SessionExtraParameters)
Creates a new FIX Session with given Session Id using extra parameters.
Public methodCreateSession(SessionId, Int32, SessionExtraParameters)
Creates a new FIX Session with given Session Id using extra parameters.
Public methodCreateSession(String, String, FixVersion, SessionExtraParameters)
Creates a new FIX Session using extra parameters.
Public methodCreateSession(String, String, Int32, SessionExtraParameters)
Creates a new FIX Session using extra parameters.
Public methodCreateSession(SessionId, FixVersion, SessionExtraParameters, FixVersion)
Creates a new FIX Session with given Session Id using extra parameters.
Public methodCreateSession(SessionId, FixVersion, SessionExtraParameters, MessageStorageType)
Creates a new FIX Session with given Session Id using extra parameters.
Public methodCreateSession(SessionId, Int32, SessionExtraParameters, FixVersion)
Creates a new FIX Session with given Session Id using extra parameters.
Public methodCreateSession(SessionId, Int32, SessionExtraParameters, MessageStorageType)
Creates a new FIX Session with given Session Id using extra parameters.
Public methodCreateSession(String, String, FixVersion, SessionExtraParameters, FixVersion)
Creates a new FIX Session using extra parameters.
Public methodCreateSession(String, String, FixVersion, SessionExtraParameters, MessageStorageType)
Creates a new FIX Session using extra parameters.
Public methodCreateSession(String, String, Int32, SessionExtraParameters, FixVersion)
Creates a new FIX Session using extra parameters.
Public methodCreateSession(String, String, Int32, SessionExtraParameters, MessageStorageType)
Creates a new FIX Session using extra parameters.
Public methodCreateSession(SessionId, FixVersion, SessionExtraParameters, MessageStorageType, FixVersion)
Creates a new FIX Session with given Session Id using extra parameters.
Public methodCreateSession(SessionId, Int32, SessionExtraParameters, MessageStorageType, FixVersion)
Creates a new FIX Session with given Session Id using extra parameters.
Public methodCreateSession(String, String, FixVersion, SessionExtraParameters, MessageStorageType, FixVersion)
Creates a new FIX Session using extra parameters.
Public methodCreateSession(String, String, Int32, SessionExtraParameters, MessageStorageType, FixVersion)
Creates a new FIX Session using extra parameters.
Public methodDispose
Releases all resources used by the FixEngine
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodgetConfiguredSessions
Returns dictionary of configured sessions
Public methodStatic memberGetFieldName
Returns name of the field
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodStatic memberGetMessages
Returns messages registered in protocol
Public methodGetParserID
Returns unique parser ID
Public methodGetProtocolID
Returns unique parser ID deprecated, use GetParserID
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodLoadProtocolFile
Loads protocol definition/customization file
Public methodStatic memberSetAdditionalFields
Initializes the additional fields.
Public methodStop
Stops the engine.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Properties

  NameDescription
Public propertyAdditionalFields
FIX tags that do not belong to the message in compliance with the version specified for a FIX session, but that should still be allowed (or required) instead of causing a rejection of the FIX message.
  • for FIX 4.2, MsgType 8 (Execution Report): allow fields 639 and 204 -
  • for FIX 4.1, MsgType 9 (Order Cancel Reject): require field 41 (because the '?' symbol is absent). FIX42:8:639?,204?;FIX41:9:41 -
Public propertyCheckOutgoingMsgsVer
Returns true if it is necessary to check that the version of outgoing messages is equal to the version of the session otherwise false.
Public propertyDeliveryTriesInterval
Returns the time interval between tries to deliver application message (in milliseconds).
Public propertyFailOverCommandPort
Returns Failover Command Port.
Public propertyFailOverDataPort
Returns Failover Data Port.
Public propertyFailOverHost
Returns the stand-by node address.
Public propertyForceSeqNumReset
An option to automaticaly reset sequence number of the unregistered acceptors.
Public propertyStatic memberInstance
Returns an instance of this class.
Public propertyIsAllowZeroNumInGroup
Returns true when "AllowZeroNumInGroup" defined and true, false otherwise.
Public propertyIsCheckRequiredGroupFields
Returns if it is necessary to check that the version of outgoing messages is equal to the version of the session otherwise .
Public propertyIsCreateUnregisteredAcceptorSessionMode
Returns true if "CreateUnregisteredAcceptorSession" mode must be used, false otherwise.
Public propertyIsExtraSafeMode
If than file streams are flushed after each I/O operation.
Public propertyIsFailOverMode
Returns true if the automatic failover mechanism is on. If false then it is off.
Public propertyIsGatherSessionStatistic
Returns if statistics about Engine's perfomance will be gathered. Otherwise .
Public propertyIsIgnoreseqNumTooLowAtLogon
Returns true if "UnregisteredAcceptor.IgnoreSeqNumTooLowAtLogon" mode must be used, false otherwise.
Public propertyIsIntradayLogoutToleranceMode
Returns true if the Intraday Logout Tolerance mode is active, otherwise - false.
Public propertyIsResetSeqNumAfter24hoursMode
An option to send a Logon message with the ResetSeqNumFlag set after each 24 hour period of session's activity to establish a new set of sequence numbers (starting with 1).
Public propertyIsThirdPartyRoutingEnabled
Returns true if the third-party routing is enabled, false otherwise.
Public propertyIsTimestampsInLogsMode
An option to write timestamps in the log files.
Public propertyListenPort
Returns Engine's listen port.
Public propertyLogDir
Returns log directory's name.
Public propertyLogFileName
Returns engine's log file name.
Public propertyLogIncomingMessages
Returns true if the incoming messages from a remote FIX Engine must be logged, otherwise false.
Public propertyLogonTimeFrame
Returns the logon time frame.
Public propertyLogoutTimeFrame
Returns the logout time frame.
Public propertyMaxDeliveryTries
Returns the maximum number of tryes to deliver application message.
Public propertyMaxReconnectTries
Returns the maximum number of tryes to to restore the telecommunications link. If -1 then the number of tryes is unlimited.
Public propertyMessageMustBeValidated
Returns true if the validity of the input message must be checked, false otherwise.
Public propertyMessageTimeToLive
The time period after which a message rejecting is starting while session isn't exists.
Public propertyNumberOfWorkers
Returns the number of workers.
Public propertyOutgoingMessagesStorageSize
Returns the maximum number of outgoing messages that can be retransmitted in case of Resend Requests. If '-1' then the size is unlimited.
Public propertyReasonableTransmissionTime
Returns reasonable transmission time - in % from HeartBeat value.
Public propertyReconnectInterval
Returns the time interval between tries to restore the telecommunications link (in milliseconds)
Public propertyResendMessagesBlockSize
Resend Request resend messages by blocks. This parameter defines how many messages procceed in block. By default parameter is 0 - all messages will be resend in one block.
Public propertyRole
Returns the current failover role.
Public propertyRoot
Returns the top of the directory tree under which the engine's configuration, and log files are kept.
Public propertySessionStorageType
Returns the default session's storage type.
Public propertyStatistics
Returns information about current engine's sessions information.
Top
Events

  NameDescription
Public eventError
Called when the FixEngine generates an error.
Public eventNotification
Called when the FixEngine generates a notification.
Public eventUnregisteredAcceptor
Called by FIX Engine when a new acceptor's session was created without the registered aplication.
Public eventWarning
Called when the FixEngine generates a warning.
Top
Remarks

The FixEngine class, as well as some other FIX Antenna C++ .NET API classes, implements “Singleton” Design Pattern, therefore to access non-static methods of the class, it is necessary to get the pointer to the class singular instance, first, using the FixEngine.Instance() static property.
Remarks

It is very important to stop the engine before exiting the program.
See Also

Reference