EngineException Events | Table of Content | EngineSettings Constructor |
EngineSettings Class |
Namespace: FIXForge.NET.FIX
public sealed class EngineSettings : IDisposable
The EngineSettings type exposes the following members.
Name | Description | |
---|---|---|
EngineSettings | Initializes a new instance of the EngineSettings class |
Name | Description | |
---|---|---|
AsyncFileBasedStorageQueueMaxSize |
Maximum size of the asynchronous session storage log queue. The default value is OxFFFFFFFF (unlimited).
| |
AsyncFileBasedStorageThreadAffinity |
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.
| |
CreateEngineLogFile |
Option to create the FIX Engine Log file.
| |
Dialect |
Specifies path(s) to XML file(s) with the description of FIX dialect(s).
Symbol '|' is used as a filename delimiter.
| |
DialectString |
Specifies the plain text string with a description of FIX dialect.
| |
ExpectedIncomingMessageSize |
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.
| |
FileBasedStorageSegmentSize |
Maximum size of single .summary file in bytes. The default value is 0 (unlimited).
| |
FirstLogonTimeout |
Timeout (in seconds) between an incoming TCP connection is detected and the first Logon message is received.
If the first Logon message is not received during this timeout + reasonable transmission time, the connection will be closed.
| |
IgnoreFileBasedStorageIntegrityErrors |
Option to ignore storage integrity errors if FileBasedStorage type was used.
| |
LicenseAlertingDaysBeforeExpiration |
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.
| |
LicenseFile |
Specifies the path to the license file.
| |
LicenseStore |
Specify the path(s) to the folder that contains license file(s).
Symbol '|' is used as a path delimiter.
| |
LicenseString |
Specify the string of license content.
| |
ListenPort |
The FIX Engine listens on this port for incoming connections.
| |
ListenPorts |
The FIX Engine listens on these ports for incoming connections.
| |
LocalInterface |
Network interfaces used by the engine.
| |
LocalTimeUsage |
Specifies the usage of local time in FIX Engine events and log files.
| |
LogBeforeSending |
Option to switch on/off logging of outbound messages before/after sending.
| |
LogDirectory |
Inbound and outbound FIX messages, session's state data, and the FIX Engine log files are stored in this directory.
| |
LogFileName |
Specifies the FIX Engine log file name.
| |
LogInboundMessages |
Option to log incoming messages.
| |
LogOutboundMessages |
Option to log outbound messages.
| |
MessageGrouping |
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).
| |
ProcessDeliverToCompID |
Option to automatically process DeliverToCompID, tag=128 field.
| |
ReasonableTransmissionTime |
Reasonable transmission time as % from HeartBtInt value.
| |
ReceiveBufferSize |
The size of the buffer allocated to the FIX connection for receiving data. If '-1' then the default operating system value is used.
| |
ReceiveSpinningTimeout |
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).
| |
ReconnectAttempts |
Number of attempts to restore the FIX connection.
| |
ReconnectInterval |
Time interval between attempts to restore the FIX connection (in seconds).
| |
ReportNewMessagesWhileWaitingForMissedMessages |
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.
| |
ResendingQueueSize |
Number of sent messages that are available for resending on counterparty's Resend Request (MsgType=2) message.
| |
ResendRequestMaximumRange |
Maximum number of messages to be requested in one Resend Request (MsgType=2) message. By default, it is zero (no limit).
| |
ScrambleLogonFields |
The option to scramble fields in the Logon(A) message, in the session storage and FIX Engine log, for security reasons.
| |
SendBufferSize |
The size of the buffer allocated to the FIX connection for sending data. If '-1' then the default operating system value is used.
| |
SendLogoutOnException |
Option to send the Logout message before dropping the telecommunication link in case of Exception during the processing of incoming FIX message.
| |
SendLogoutOnInvalidLogon |
Option to send the Logout message before dropping the telecommunication link in reply on an invalid logon attempt.
| |
SendQueueMaxSize |
The option to set the send queue maximum size in bytes.
| |
SendSpinningTimeout |
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).
| |
ServiceThreadAffinity |
Option to specify the CPU index(es) for affinity of the Engine service threads. Symbol ',' is used as the CPU index delimiter.
| |
ServiceThreadPriority |
Option to specify the priority of the Engine service threads.
| |
SpecifyApplVerIdField |
Option to specify ApplVerID(1128) tag in all application FIX messages when a FIX protocol version FIX 5.0 and above is used.
| |
SpecifyLastMsgSeqNumProcessed | 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. | |
SslCaFile |
Path to the trusted certification authority certificate file in PEM (base 64 encoded) format.
| |
SslCertificateFile |
Path to the SSL certificate file in PEM (base 64 encoded) format.
| |
SslListenPort |
The FIX Engine listens on this port for incoming SSL-encrypted connections.
| |
SslListenPorts |
The FIX Engine listens on these ports for incoming SSL-encrypted connections.
| |
SslLocalInterface |
Local interfaces where engine listens for incoming SSL connections. Interfaces could be specified as name or IP-address with optional trailing port number.
| |
SslMaxProtocolVersion |
The maximal SSL/TLS protocol version that will be declared during the SSL/TLS handshake.
| |
SslMinProtocolVersion |
The minimal SSL/TLS protocol version that will be declared during the SSL/TLS handshake.
| |
SslPrivateKeyFile |
Path to the SSL private key file in PEM (base 64 encoded) format.
| |
SslPrivateKeyPassword |
Password to open SSL private key file.
| |
SslVerifyPeer |
Option to verify SSL client certificate.
| |
TcpNoDelayOption |
Option to improve latency at the expense of message throughput.
| |
ThreadingModel |
FIX Session Connection Mode.
| |
ThreadPoolSize |
Size of the thread pool that is used if ThreadingModel.ThreadPool connection mode is specified.
| |
UseMemoryPressure |
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.
| |
ValidateChecksum |
Option to turn on/off incoming message checksum validation.
| |
ValidateDuplicatedField |
Option to turn on/off incoming message field duplicate validation.
| |
ValidateEmptyFieldValues |
Option to validate empty message field values.
| |
ValidateFieldValues |
Option to validate field values of FIX messages in accordance with the FIX protocol or its FIX Dialect.
| |
ValidateRepeatingGroupEntryCount |
Option to validate that the declared number of repeating group instances is equal to the actual one.
| |
ValidateRepeatingGroupLeadingTag |
Option to validate that repeating group starts from required by dialect leading tag.
| |
ValidateRequiredFields |
Option to validate that all required fields are set.
| |
ValidateUnknownFields |
Option to validate that there are no unknown message fields.
| |
ValidateUnknownMessages |
Option to validate that there are no unknown messages received.
|
Name | Description | |
---|---|---|
Dispose() | Releases all resources used by the EngineSettings | |
Dispose(Boolean) | Releases the unmanaged resources used by the EngineSettings and optionally releases the managed resources | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
ToString |
Returns a string that represents the current object.
(Overrides Object.ToString().) |