Fix |
FIX Engine. This class is responsible for: initialization, creating sessions and
obtaining state information.
Inheritance HierarchyNamespace: com.b2bits.FIXAntenna
Assembly: FIXAntenna_net4.8 (in FIXAntenna_net4.8.dll) Version: 2.32.0.0
SyntaxThe FixEngine type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CheckOutgoingMsgsVer | Returns true if it is necessary to check that the version of outgoing messages is equal to the version of the session otherwise false. |
| DeliveryTriesInterval | Returns the time interval between tries to deliver application message (in milliseconds). |
| FailOverCommandPort | Returns Failover Command Port. |
| FailOverDataPort | Returns Failover Data Port. |
| FailOverHost | Returns the stand-by node address. |
| ForceSeqNumReset | An option to automaticaly reset sequence number of the unregistered acceptors. |
 | Instance | Returns an instance of this class. |
| IsAllowZeroNumInGroup | Returns true when "AllowZeroNumInGroup" defined and true, false otherwise. |
| IsCheckRequiredGroupFields | Returns if it is necessary to check that the version of outgoing messages is equal to the version of the session otherwise . |
| IsCreateUnregisteredAcceptorSessionMode | Returns true if "CreateUnregisteredAcceptorSession" mode must be used, false otherwise. |
| IsExtraSafeMode | If than file streams are flushed after each I/O operation. |
| IsFailOverMode | Returns true if the automatic failover mechanism is on. If false then it is off. |
| IsGatherSessionStatistic | Returns if statistics about Engine's perfomance will be gathered. Otherwise . |
| IsIgnoreseqNumTooLowAtLogon | Returns true if "UnregisteredAcceptor.IgnoreSeqNumTooLowAtLogon" mode must be used, false otherwise. |
| IsIntradayLogoutToleranceMode | Returns true if the Intraday Logout Tolerance mode is active, otherwise - false. |
| IsResetSeqNumAfter24hoursMode | 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). |
| IsThirdPartyRoutingEnabled | Returns true if the third-party routing is enabled, false otherwise. |
| IsTimestampsInLogsMode | An option to write timestamps in the log files. |
| ListenPort | Returns Engine's listen port. |
| LogDir | Returns log directory's name. |
| LogFileName | Returns engine's log file name. |
| LogIncomingMessages | Returns true if the incoming messages from a remote FIX Engine must be logged, otherwise false. |
| LogonTimeFrame | Returns the logon time frame. |
| LogoutTimeFrame | Returns the logout time frame. |
| MaxDeliveryTries | Returns the maximum number of tryes to deliver application message. |
| MaxReconnectTries | Returns the maximum number of tryes to to restore the telecommunications link. If -1 then the number of tryes is unlimited. |
| MessageMustBeValidated | Returns true if the validity of the input message must be checked, false otherwise. |
| MessageTimeToLive | The time period after which a message rejecting is starting while session isn't exists. |
| NumberOfWorkers | Returns the number of workers. |
| OutgoingMessagesStorageSize | Returns the maximum number of outgoing messages that can be retransmitted in case of Resend Requests. If '-1' then the size is unlimited. |
| ReasonableTransmissionTime | Returns reasonable transmission time - in % from HeartBeat value. |
| ReconnectInterval | Returns the time interval between tries to restore the telecommunications link (in milliseconds) |
| ResendMessagesBlockSize | 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. |
| Role | Returns the current failover role. |
| Root | Returns the top of the directory tree under which the engine's configuration, and log files are kept. |
| SessionStorageType | Returns the default session's storage type. |
| Statistics | Returns information about current engine's sessions information. |
Methods| Name | Description | |
|---|---|---|
 | BackupLogFile | Backups engine's log file under the given name and opens a new one. |
| ClearAdditionalFields | Destroys the additional fields. |
| Create | Initializes the FixEngine using default settings. |
| Create(FixEngineStartupParams) | Initializes the FixEngine using startup parameters. |
| Create(String) | Initializes the FixEngine using property file. |
| CreateFastSession(SessionId, FixVersion, String) | Creates a new FIX Session with given Session Id. |
| CreateFastSession(SessionId, FixVersion, SessionExtraParameters, String) | Creates a new FIX Session with given Session Id using extra parameters. |
| CreateFastSession(String, String, FixVersion, String) | Creates a new FIX Session. |
| CreateFastSession(SessionId, FixVersion, SessionExtraParameters, MessageStorageType, String) | Creates a new FIX Session with given Session Id using extra parameters. |
| CreateFastSession(String, String, FixVersion, SessionExtraParameters, String) | Creates a new FIX Session using extra parameters. |
| CreateFastSession(String, String, FixVersion, SessionExtraParameters, MessageStorageType, String) | Creates a new FIX Session using extra parameters. |
| CreateFixParser(String, DictionaryFixVersion, String) | |
| CreateFixParser(String, String, DictionaryFixVersion, String) | |
| CreateMDApplication(MDAppParams) | Creates a new CME MDApplication |
| CreateMDApplication(MDAppParams, MDApplicationListener) | Creates a new CME MDApplication |
| CreateMDApplication(MDAppParams, MockDataPublisher) | Creates a new CME MDApplication |
| CreateMDApplication(MDAppParams, MDApplicationListener, MockDataPublisher) | Creates a new CME MDApplication |
| CreateProtocol | Register new custom FIX Protocol and returns its identifier |
| CreateSession(SessionId, FixVersion) | Creates a new FIX Session with given Session Id. |
| CreateSession(SessionId, FixVersion, SessionExtraParameters) | Creates a new FIX Session with given Session Id using extra parameters. |
| CreateSession(SessionId, Int32, SessionExtraParameters) | Creates a new FIX Session with given Session Id using extra parameters. |
| CreateSession(String, String, FixVersion) | Creates a new FIX Session. |
| CreateSession(SessionId, FixVersion, SessionExtraParameters, FixVersion) | Creates a new FIX Session with given Session Id using extra parameters. |
| CreateSession(SessionId, FixVersion, SessionExtraParameters, MessageStorageType) | Creates a new FIX Session with given Session Id using extra parameters. |
| CreateSession(SessionId, Int32, SessionExtraParameters, FixVersion) | Creates a new FIX Session with given Session Id using extra parameters. |
| CreateSession(SessionId, Int32, SessionExtraParameters, MessageStorageType) | Creates a new FIX Session with given Session Id using extra parameters. |
| CreateSession(String, String, FixVersion, SessionExtraParameters) | Creates a new FIX Session using extra parameters. |
| CreateSession(String, String, Int32, SessionExtraParameters) | Creates a new FIX Session using extra parameters. |
| CreateSession(SessionId, FixVersion, SessionExtraParameters, MessageStorageType, FixVersion) | Creates a new FIX Session with given Session Id using extra parameters. |
| CreateSession(SessionId, Int32, SessionExtraParameters, MessageStorageType, FixVersion) | Creates a new FIX Session with given Session Id using extra parameters. |
| CreateSession(String, String, FixVersion, SessionExtraParameters, FixVersion) | Creates a new FIX Session using extra parameters. |
| CreateSession(String, String, FixVersion, SessionExtraParameters, MessageStorageType) | Creates a new FIX Session using extra parameters. |
| CreateSession(String, String, Int32, SessionExtraParameters, FixVersion) | Creates a new FIX Session using extra parameters. |
| CreateSession(String, String, Int32, SessionExtraParameters, MessageStorageType) | Creates a new FIX Session using extra parameters. |
| CreateSession(String, String, FixVersion, SessionExtraParameters, MessageStorageType, FixVersion) | Creates a new FIX Session using extra parameters. |
| CreateSession(String, String, Int32, SessionExtraParameters, MessageStorageType, FixVersion) | Creates a new FIX Session using extra parameters. |
| Dispose | Releases all resources used by the FixEngine |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| getConfiguredSessions | Returns dictionary of configured sessions |
| GetFieldName | Returns name of the field |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetMessages | Returns messages registered in protocol |
| GetParserID | Returns unique parser ID |
| GetParsers | Returns descriptions of configured parsers |
| GetProtocolID | Returns unique parser ID deprecated, use GetParserID |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| LoadProtocolFile | Loads protocol definition/customization file |
| StartListeningIncomingConnections | Starts listening for incomming connections |
| Stop | Stops the engine. |
| StopListeningIncomingConnections | Stops listening for incomming connections |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events| Name | Description | |
|---|---|---|
 | Error | Called when the FixEngine generates an error. |
| Notification | Called when the FixEngine generates a notification. |
| UnregisteredAcceptor | Called by FIX Engine when a new acceptor's session was created without the registered aplication. |
| Warning | Called when the FixEngine generates a warning. |
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.
See Also