forwardEngineException Events   Table of ContentEngineSettings Constructor forward
EngineSettings Class
FIX Engine settings.
Inheritance Hierarchy
System.Object
  FIXForge.NET.FIX.EngineSettings

Namespace:  FIXForge.NET.FIX
Assembly:  FIXForge.NET.FIX.Engine-net-4.6.2_x64 (in FIXForge.NET.FIX.Engine-net-4.6.2_x64.dll) Version: 4.5.0.0
Syntax
C#
public sealed class EngineSettings

The EngineSettings type exposes the following members.

Constructors
  NameDescription
Public methodEngineSettings
Initializes a new instance of the EngineSettings class
Top
Properties
  NameDescription
Public propertyAsyncFileBasedStorageQueueMaxSize
Maximum size of the asynchronous session storage log queue. The default value is OxFFFFFFFF (unlimited).
Public propertyAsyncFileBasedStorageThreadAffinity
Option to specify the CPU index(es) for affinity of the asynchronous session storage threads. Symbol ',' is used as the CPU index delimiter. This affinity will be used by all asynchronous session storages of all sessions.
Public propertyCreateEngineLogFile
Option to create the FIX Engine Log file.
Public propertyDialect
Specifies path(s) to XML file(s) with the description of FIX dialect(s). Symbol '|' is used as a filename delimiter.
Public propertyDialectString
Specifies the plain text string with a description of FIX dialect.
Public propertyExpectedIncomingMessageSize
The setting represents an average FIX message size that is expected to be received by the session during the lifetime. It is used as a hint for the optimization of the deserialization of large FIX messages with a lot of repeating groups. The large value of the setting can increase the memory consumption by the incoming Message object, so try to increase the value only in case of a latency degradation of the large incoming FIX messages deserialization.
Public propertyFileBasedStorageSegmentSize
Maximum size of single .summary file in bytes. The default value is 0 (unlimited).
Public propertyIgnoreFileBasedStorageIntegrityErrors
Option to ignore storage integrity errors if FileBasedStorage type was used.
Public propertyLicenseAlertingDaysBeforeExpiration
Specify the number of days to alert before the license expiration. If the number of remaining license days is less or equal to this number then the warning will be reported to the FIX Engine's log and Engine.Warning event will be invoked. The verification is performed during the following events: FIX Engine initialization, Session.LogonAsAcceptor and Session.LogonAsInitiator calls.
Public propertyLicenseFile
Specifies the path to the license file.
Public propertyLicenseStore
Specify the path(s) to the folder that contains license file(s). Symbol '|' is used as a path delimiter.
Public propertyLicenseString
Specify the string of license content.
Public propertyListenPort
The FIX Engine listens on this port for incoming connections.
Public propertyListenPorts
The FIX Engine listens on these ports for incoming connections.
Public propertyLocalInterface
Network interfaces used by the engine.
Public propertyLocalTimeUsage
Specifies the usage of local time in FIX Engine events and log files.
Public propertyLogBeforeSending
Option to switch on/off logging of outbound messages before/after sending.
Public propertyLogDirectory
Inbound and outbound FIX messages, session's state data, and the FIX Engine log files are stored in this directory.
Public propertyLogFileName
Specifies the FIX Engine log file name.
Public propertyLogInboundMessages
Option to log incoming messages.
Public propertyLogOutboundMessages
Option to log outbound messages.
Public propertyMessageGrouping
Specifies message grouping option. Value 0 means default grouping - the messages will be tried to send ASAP and pending messages (if any) will be grouped till reaching of TCP buffer size. Value 1 means the messages will be sent ASAP and never will be grouped. Value 2 (or greater) means the messages will be sent ASAP and pending messages will be grouped maximum by 2 (or greater).
Public propertyProcessDeliverToCompID
Option to automatically process DeliverToCompID, tag=128 field.
Public propertyReasonableTransmissionTime
Reasonable transmission time as % from HeartBtInt value.
Public propertyReceiveBufferSize
The size of the buffer allocated to the FIX connection for receiving data. If '-1' then the default operating system value is used.
Public propertyReceiveSpinningTimeout
Specifies the non-blocking receive spinning timeout (in microseconds) before the receiving thread enters into the blocking wait mode. Should not be greater than 1 sec (minimal Heartbeat interval).
Public propertyReconnectAttempts
Number of attempts to restore the telecommunication link.
Public propertyReconnectInterval
Time interval between attempts to restore the telecommunication link (in seconds).
Public propertyReportNewMessagesWhileWaitingForMissedMessages
When the message gap is detected the "Resend Request" FIX Message is sent and Session state is changed to "AwaitReplyOnResendRequest". By default, in this state, the incoming new messages (without the PossDupFlag (tag #43) flag) are ignored because we expect them to be re-sent later again with the PossDupFlag flag. This property allows to change this behavior and report the new messages anyway. Note: In this mode messages could be reported out of the original order: e.g. MsgSeqNum could be: 3 (original), 4 (original), 2 (PossDupFlag='Y'), 3 (PossDupFlag='Y'), 4 (PossDupFlag='Y') and some messages could be received two times: first time without PossDupFlag='Y' and second time - with this flag.
Public propertyResendingQueueSize
Number of sent messages that are available for resending on counterparty's Resend Request (MsgType=2) message.
Public propertyResendRequestMaximumRange
Maximum number of messages to be requested in one Resend Request (MsgType=2) message. By default, it is zero (no limit).
Public propertySendBufferSize
The size of the buffer allocated to the FIX connection for sending data. If '-1' then the default operating system value is used.
Public propertySendLogoutOnException
Option to send the Logout message before dropping the telecommunication link in case of Exception during the processing of incoming FIX message.
Public propertySendLogoutOnInvalidLogon
Option to send the Logout message before dropping the telecommunication link in reply on an invalid logon attempt.
Public propertySendSpinningTimeout
Specifies the send spinning timeout (in microseconds) of the Send(Message) method to wait for the socket sending buffer availability in the spin loop mode before placing the message to the outgoing queue (to be sent later by the sending thread). Should not be greater than 1 sec (minimal Heartbeat interval).
Public propertyServiceThreadAffinity
Option to specify the CPU index(es) for affinity of the Engine service threads. Symbol ',' is used as the CPU index delimiter.
Public propertyServiceThreadPriority
Option to specify the priority of the Engine service threads.
Public propertySpecifyApplVerIdField
Option to specify ApplVerID(1128) tag in all application FIX messages when a FIX protocol version FIX 5.0 and above is used.
Public propertySpecifyLastMsgSeqNumProcessed
Option to specify the LastMsgSeqNumProcessed, tag=369 field on every message sent. Useful for detecting a backlog with a counterparty. By default, the option value is false.
Public propertySslCaFile
Path to the trusted certification authority certificate file in PEM (base 64 encoded) format.
Public propertySslCertificateFile
Path to the SSL certificate file in PEM (base 64 encoded) format.
Public propertySslListenPort
The FIX Engine listens on this port for incoming SSL-encrypted connections.
Public propertySslListenPorts
The FIX Engine listens on these ports for incoming SSL-encrypted connections.
Public propertySslLocalInterface
Local interfaces where engine listens for incoming SSL connections. Interfaces could be specified as name or IP-address with optional trailing port number.
Public propertySslPrivateKeyFile
Path to the SSL private key file in PEM (base 64 encoded) format.
Public propertySslPrivateKeyPassword
Password to open SSL private key file.
Public propertySslVerifyPeer
Option to verify SSL client certificate.
Public propertyTcpNoDelayOption
Option to improve latency at the expense of message throughput.
Public propertyThreadingModel
FIX Session Connection Mode.
Public propertyThreadPoolSize
Size of the thread pool that is used if ThreadingModel.ThreadPool connection mode is specified.
Public propertyUseMemoryPressure
Option to inform the .NET runtime about allocated unmanaged memory. The default value is true. If this value was false, latency will be improved because of less GC work, but in case of a lot of large messages can cause OutOfMemoryException. It is safe to set this option to false, if Message.Dispose() called for each message.
Public propertyValidateChecksum
Option to turn on/off incoming message checksum validation.
Public propertyValidateDuplicatedField
Option to turn on/off incoming message field duplicate validation.
Public propertyValidateEmptyFieldValues
Option to validate empty message field values.
Public propertyValidateFieldValues
Option to validate field values of FIX messages in accordance with the FIX protocol or its FIX Dialect.
Public propertyValidateRepeatingGroupEntryCount
Option to validate that the declared number of repeating group instances is equal to the actual one.
Public propertyValidateRepeatingGroupLeadingTag
Option to validate that repeating group starts from required by dialect leading tag.
Public propertyValidateRequiredFields
Option to validate that all required fields are set.
Public propertyValidateUnknownFields
Option to validate that there are no unknown message fields.
Public propertyValidateUnknownMessages
Option to validate that there are no unknown messages received.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Overrides Object.ToString().)
Top
See Also