B2BITS FIX Antenna C++  2.27.0
Variables
Engine::FIXPropertiesNames Namespace Reference

List of all engine.properties parameters. More...

Variables

const std::string ANCHOR_FILE_NAME = "AnchorFile"
 
const std::string BACKUP_DIRECTORY_PARAM = "BackupDirectory"
 Relative path to the backup folder. More...
 
const std::string CHECK_VERSION_OUTGOING_MESSAGE_PARAM = "CheckVersionOfOutgoingMessages"
 This parameter is an option whereby the version of FIX protocol used for the outgoing message is validated against that of the established session. More...
 
const std::string CONNECT_ADDRESS_PARAM = "ConnectAddress"
 Engine's local IP address to send messages from. More...
 
const std::string CREATE_UNREGISTERED_ACCEPTOR_SESSION_PARAM = "CreateUnregisteredAcceptorSession"
 This parameter provides an option whereby FIX Engine will accept a FIX session for which it has no registered application (an acceptor). More...
 
const std::string DBL_TCP_LISTEN_ADDRESSES = "Myricom.Dbl.TcpListenAddresses"
 DBL TCP listen address and port. More...
 
const std::string DBL_USE_SOCKET_ADAPTOR = "Myricom.Dbl.UseSocketAdaptor"
 This property tells how will be initialized Myricom DBL TCP API. More...
 
const std::string DEBUG_LOG_SESSION_EXTRA_PARAMETERS_PARAM = "Debug.LogSessionExtraParameters"
 If this property value is true, all session parameters will be printed to the engine.log file. More...
 
const std::string DICTIONARIES_FILES_LIST = "DictionariesFilesList"
 This parameter contains name of the XML file with extensions of the FIX protocols. More...
 
const std::string DISPATCHER_RECV_WORKERS_COUNT = "Dispatcher.RecvWorkersCount"
 Defines number of workers to handle incoming messages. More...
 
const std::string DISPATCHER_RECV_WORKERS_TIMEOUT = "Dispatcher.RecvWorkersTimeout"
 Defines number of milliseconds to wait for readiness of the socket to receive data. More...
 
const std::string DISPATCHER_SEND_WORKERS_COUNT = "Dispatcher.SendWorkersCount"
 Defines number of workers to handle outgoing messages. More...
 
const std::string DISPATCHER_SEND_WORKERS_TIMEOUT = "Dispatcher.SendWorkersTimeout"
 Defines number of milliseconds to wait for readiness of the socket to send data. More...
 
const std::string DP_DELIVERY_TRIES_INTERVAL_PARAM = "DelayedProcessing.DeliveryTriesInterval"
 This parameter specifies the time interval between attempts to deliver an application level message to a registered client application in the event the application does not confirm receipt and operation upon the message. More...
 
const std::string DP_MAX_DELIVARY_TRIES_PARAM = "DelayedProcessing.MaxDeliveryTries"
 This parameter specifies the number of attempts that will be made to deliver an application level message to the registered client application. More...
 
const std::string DUPLICATE_RESEND_REQUEST_LIMIT_PARAM = "DuplicateResendRequestLimit"
 Specified how much same ResendRequests received before Application::onResendRequestLoop is called. More...
 
const std::string ENABLE_AUTO_SWITCH_TO_BACKUP_CONNECTION_PARAM = "EnableAutoSwitchToBackupConnection"
 
const std::string ENABLE_CYCLIC_SWITCH_BACKUP_CONNECTION = "EnableCyclicSwitchBackupConnection"
 
const std::string ENABLE_DNS_ENTRY_SPOOFING_DETECTION = "EnableDnsEntrySpoofingDetection"
 When it's set to true there is being enabled backward resolve based DNS entry spoofing detection mechanism in DNS related functions. More...
 
const std::string ENABLE_INCREMENTAL_LOG_FILE_CREATION_PARAM = "EnableIncrementalLogFileCreation"
 Setting property "true" will reserve 10Mb of disc space for logging. More...
 
const std::string ENCRYPTION_CONFIG_FILE_PARAM = "EncryptionConfigFile"
 Encryption config file. More...
 
const std::string ENGINE_ROOT_PARAM = "EngineRoot"
 The top of the directory tree under which the engine's configuration, and log files are kept. More...
 
const std::string EXTRA_SAFE_MODE_PARAM = "ExtraSafeMode"
 If this parameter is true than file streams are flushed after each I/O operation. More...
 
const std::string FAILOVER_COMMAND_PORT_PARAM = "FailOver.CommandPort"
 
const std::string FAILOVER_HOST_PARAM = "FailOver.Host"
 
const std::string FAILOVER_IS_PRIMARY_PARAM = "FailOver.IsPrimary"
 
const std::string FAILOVER_MODE_PARAM = "FailOver.Mode"
 
const std::string FAILOVER_PORT_PARAM = "FailOver.Port"
 
const std::string FORCE_SEQNUM_RESET_PARAM = "ForceSeqNumReset"
 This parameter allow to automatically resolve sequence gap problem. More...
 
const std::string FORCE_SEQNUM_RESET_VALUE_ALWAYS = "ALWAYS"
 Value of the ForceSeqNumReset parameter. More...
 
const std::string FORCE_SEQNUM_RESET_VALUE_FALSE = "false"
 Value of the ForceSeqNumReset parameter. More...
 
const std::string FORCE_SEQNUM_RESET_VALUE_NA = "NA"
 Value of the ForceSeqNumReset parameter. More...
 
const std::string FORCE_SEQNUM_RESET_VALUE_OFF = "OFF"
 Value of the ForceSeqNumReset parameter. More...
 
const std::string FORCE_SEQNUM_RESET_VALUE_ON = "ON"
 Value of the ForceSeqNumReset parameter. More...
 
const std::string FORCE_SEQNUM_RESET_VALUE_TRUE = "true"
 
const std::string HELPER_CPU_AFFINITY = "HelperCpuAffinity"
 Defines an affinity mask for dispatcher and other auxiliary threads threads. More...
 
const std::string IDX_INCREMENT_SIZE_PARAM = "Persistents.IdxIncrementSize"
 Specifies amount of memory in bytes reserved for memory mapped file message storage for *.idx file It defines how FIX Antenna reserves space on the HDD for PersistentMM (in any cases) and Persistent (if EnableIncrementalLogFileCreation is ON). More...
 
const std::string INDEX_REBUILD_ENABLED_PARAM = "MessageStorage.IndexRebuildEnabled"
 If this parameter is true, FIX Engine will try to restore index file from log file in case when index file is missed or corrupted This parameter is optional, default value is false. More...
 
const std::string INDEX_REBUILD_REQUIRE_REJECT_FLAG = "MessageStorage.RequireRejectFlagSupport"
 If this option is enabled, FIX Engine will not rebuild index files for message storages, that does not support embedded Reject Flag Marker This parameter is optional, default value is true. More...
 
const std::string INTRADAY_LOGOUT_TOLERANCE_PARAM = "IntradayLogoutTolerance"
 An option not to reset sequence numbers after Logout. More...
 
const std::string IS_FORWARDING_FIXMESSAGES_TO_LOG = "IsForwardingFixMessagesToLog"
 This parameter for forwarding fix messages to log system if set to true then incoming/outgoing fix messages add in log system with level UNFO if set to false then incoming/outgoing fix messages don't add in log system. More...
 
const std::string KEEP_MILLISECONDS_IN_UTCTIME_FIELDS = "KeepMillisecondsInUTCTimeFields"
 Defines how to serialize UTCTimestamp or UTCTimeOnly field values: 0 - default mode - if the value of milliseconds is not equal to 0 then it will be serialized. More...
 
const std::string LICENSE_FILE_PARAM = "LicenseFile"
 The license file path. More...
 
const std::string LISTEN_ADDRESS_PARAM = "ListenAddress"
 Engine's local IP address to bind to. More...
 
int const LISTEN_PORT_IN_DISABLED = -2
 
int const LISTEN_PORT_NA = -1
 
int const LISTEN_PORT_NETWORK_DISABLED = 0
 
const std::string LISTEN_PORT_PARAM = "ListenPort"
 Engine's listen port. More...
 
const std::string LISTEN_SSL_PORT_PARAM = "ListenSSLPort"
 Engine's listen SSL port. More...
 
const std::string LOG_CYCLING_PARAM = "Log.Cycling"
 
const std::string LOG_DEBUG_IS_ON_PARAM = "Log.DebugIsOn"
 
const std::string LOG_DEVICE_PARAM = "Log.Device"
 
const std::string LOG_DIRECTORY_PARAM = "LogDirectory"
 This property is the path of the directory in which the logs for all incoming (if LogIncomingMessages is set to "true") and outgoing FIX messages are stored. More...
 
const std::string LOG_ERROR_IS_ON_PARAM = "Log.ErrorIsOn"
 
const std::string LOG_EVENT_LOG_SOURCE = "Log.EventLog.EventSource"
 
const std::string LOG_FATAL_IS_ON_PARAM = "Log.FatalIsOn"
 
const std::string LOG_FILE_AUTOFLUSH_PARAM = "Log.File.AutoFlush"
 
const std::string LOG_FILE_BACKUP_TIME_PARAM = "Log.File.Backup.Time"
 
const std::string LOG_FILE_LOCKED_PARAM = "Log.File.Locked"
 
const std::string LOG_FILE_NAME_PARAM = "LogFileName"
 Engine's log file name. More...
 
const std::string LOG_FILE_RECREATE_PARAM = "Log.File.Recreate"
 
const std::string LOG_FILE_ROOT_DIR_PARAM = "Log.File.RootDir"
 
const std::string LOG_FILE_ROTATE_PARAM = "Log.File.Rotate"
 
const std::string LOG_FILE_TIMEZONE_PARAM = "Log.File.TimeZone"
 
const std::string LOG_INCOMING_MESSAGES_PARAM = "LogIncomingMessages"
 This property provides an option to log incoming FIX messages (those received) from a counterparty FIX Engine. More...
 
const std::string LOG_INCREMENT_SIZE_PARAM = "Persistents.LogIncrementSize"
 Specifies amount of memory in bytes reserved for memory mapped file message storage for *.out/*.in files. More...
 
const std::string LOG_LOG_FILE_NAME_PARAM = "Log.File.Name"
 
const std::string LOG_NOTE_IS_ON_PARAM = "Log.NoteIsOn"
 
const std::string LOG_WARN_IS_ON_PARAM = "Log.WarnIsOn"
 
const std::string LOGON_TIME_FRAME_PARAM = "LogonTimeFrame"
 This parameter sets the time period after which a session is non-gracefully terminated if a response is not received to a first "Logon" message (message type A). More...
 
const std::string LOGOUT_TIME_FRAME_PARAM = "LogoutTimeFrame"
 This parameter sets the time period after which a session is automatically terminated if a response is not received to a "Logout message" (message type 5). More...
 
const std::string M_ADMIN_SEESION_DEF_DISABLE_TCP_BUFFER_PARAM = "Monitoring.AdminSessionDef.DisableTCPBuffer"
 When true TCP buffer (Nagle algorithm) will be disabled for session. More...
 
const std::string M_ADMIN_SEESION_DEF_ENCRYPT_METHOD_PARAM = "Monitoring.AdminSessionDef.EncryptMethod"
 The expected value of the encryption method. More...
 
const std::string M_ADMIN_SEESION_DEF_FORCE_SEQNUM_RESET_PARAM = "Monitoring.AdminSessionDef.ForceSeqNumResetMode"
 Force SeqNum reset mode. More...
 
const std::string M_ADMIN_SEESION_DEF_IGNORE_SEQNUM_TOO_LOW_LOGON_PARAM = "Monitoring.AdminSessionDef.IgnoreSeqNumTooLowAtLogon"
 When true, session ignore 'SeqNum too low' at incoming Logon message and continue with received SeqNum. More...
 
const std::string M_ADMIN_SEESION_DEF_INTERDAY_LOGOUT_TOLERANCE_PARAM = "Monitoring.AdminSessionDef.IntradayLogoutToleranceMode"
 Intraday logout tolerance mode. More...
 
const std::string M_ADMIN_SEESION_DEF_MAX_MESSAGES_IN_BUNCH_PARAM = "Monitoring.AdminSessionDef.MaxMessagesAmountInBunch"
 Enqueued outgoing messages could merged and sent as a single buffer. More...
 
const std::string M_ADMIN_SEESION_DEF_PASSWORD_PARAM = "Monitoring.AdminSessionDef.Password"
 The expected value of the Password (Tag 554) field in the incoming Logon message. More...
 
const std::string M_ADMIN_SEESION_DEF_SENDER_LOCATION_ID_PARAM = "Monitoring.AdminSessionDef.SenderLocationID"
 SenderLocationID (tag 142) - assigned value used to identify specific message originator's location (i.e. More...
 
const std::string M_ADMIN_SEESION_DEF_SOCKET_OP_PRIORITY_PARAM = "Monitoring.AdminSessionDef.SocketOpPriority"
 Priority of the socket SendReceive operations. More...
 
const std::string M_ADMIN_SEESION_DEF_SOURCE_IP_PARAM = "Monitoring.AdminSessionDef.SourceIPaddress"
 The expected value of the source IP address. More...
 
const std::string M_ADMIN_SEESION_DEF_TARGET_LOCATION_ID_PARAM = "Monitoring.AdminSessionDef.TargetLocationID"
 TargetLocationID_ (tag 143) - assigned value used to identify specific message destination's location (i.e. More...
 
const std::string M_ADMIN_SEESION_DEF_TARGET_SUB_ID_PARAM = "Monitoring.AdminSessionDef.TargetSubID"
 TargetSubID (tag 57) - assigned value used to identify specific individual or unit intended to receive message. More...
 
const std::string M_ADMIN_SEESION_DEF_USER_NAME_PARAM = "Monitoring.AdminSessionDef.Username"
 The expected value of the Username (Tag 553) field in the incoming Logon message. More...
 
const std::string M_LISTEN_PORT_PARAM = "Monitoring.ListenPort"
 The engine TCP listen port that is enabled for administrative sessions If port is configured it will be added to set of engine listen ports and administrative sessions will be accepted on this port only If not exists or empty common engine listen ports are used to accept administrative sessions. More...
 
const std::string MEASURING_ENABLE_PARAM = "Measuring.Enable"
 
const std::string MESSAGE_TIME_TO_LIVE_PARAM = "MessageTimeToLive"
 This parameter sets the time period after which a message rejecting is starting while session isn't exists. More...
 
const std::string MONITORING_ENABLE_PARAM = "Monitoring.Enable"
 Enables/disables Engine monitoring. More...
 
const std::string NUMBER_OF_WORKERS_PARAM = "NumberOfWorkers"
 Number of threads that serve FIX sessions (heartbeat generation/check, message rejecting, message delay delivering, etc) On Linux the recommended value is 2. More...
 
const std::string OUT_OF_SEQUENCE_MESSAGES_QUEUE_SIZE = "OutOfSequenceMessagesStrategy.QueueSize"
 This parameter sets size temporary map for processing out of sequence messages in strategy "Queue" default value is "2000". More...
 
const std::string OUT_OF_SEQUENCE_MESSAGES_STRATEGY = "OutOfSequenceMessagesStrategy"
 This parameter sets strategy for out of sequence messages Valid values: RequestAlways - send resend request on any out of sequence message RequestOnce - Send resend request on gap. More...
 
const std::string OUTGOING_MESSAGE_STORAGE_SIZE_PARAM = "OutgoingMessagesStorageSize"
 This parameter defines the upper limit to the number of outgoing messages that are resent in the event of a Resend Request. More...
 
const std::string P_DDOS_PROTECTION_ENABLE_PARAM = "ProtectionTCP.Enabled"
 Enables/disables protection from DDoS attacks. More...
 
const std::string P_DDOS_PROTECTION_SIZE_BUFFER_MAX_PARAM = "ProtectionTCP.SizeBufferMax"
 Maximum size of buffer allocated for incoming message. More...
 
const std::string P_DDOS_PROTECTION_SIZE_WAIT_HOST_MAX_PARAM = "ProtectionTCP.SizeWaitHostMax"
 Maximum number of incoming TCP connections waiting logon from one host. More...
 
const std::string P_DDOS_PROTECTION_WAIT_LOGON_PARAM = "ProtectionTCP.WaitLogon"
 Maximum waiting time in milliseconds for first FIX message from new incoming TCP connection. More...
 
const std::string PARSERS_NAMES_LIST = "AdditionalParsersList"
 This parameter defines custom raw FIX parser list delimeted by semicolon. More...
 
const std::string REASONABLE_TRANSMISSION_TIME_PARAM = "ReasonableTransmissionTime"
 This parameter specifies the delta (increment) to the Heartbeat interval between a TestRequest message being sent by FIX Engine and a Response Heartbeat being received. More...
 
const std::string RECONNECT_INTERVAL_PARAM = "Reconnect.Interval"
 This parameter specifies the time interval between reconnection attempts in order to restore a communications link. More...
 
const std::string RECONNECT_MAX_TRIES_PARAM = "Reconnect.MaxTries"
 This parameter specifies the number of attempts to restore the session. More...
 
const std::string RESEND_MESSAGES_BLOCK_SIZE_PARAM = "ResendMessagesBlockSize"
 Resend Request resend messages by blocks. More...
 
const std::string RESET_SEQNUM_AFTER_24_HOURS_PARAM = "ResetSeqNumAfter24hours"
 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). More...
 
const std::string SESSION_STORAGE_TYPE_PARAM_DEP2 = "SessionStorageType"
 Default storage type of the created unregistered sessions. More...
 
const std::string SLICED_STORAGE_BACKUP_DIRECTORY = "SplitPersistentMsgStorage.BackupDir"
 This property is the path of the directory, where sliced message storage will search for log files in case they not found in primary location. More...
 
const std::string SLICED_STORAGE_MAX_FILESIZE = "SplitPersistentMsgStorage.MaxSliceSize"
 Specifies maximum size of one slice for sliced message storage. More...
 
const std::string SSL_CA_CERTIFICATE_PARAM = "SSLCACertificate"
 Engine's SSL CA certificate file path. More...
 
const std::string SSL_CERTIFICATE_PARAM = "SSLCertificate"
 Engine's SSL certificate file path. More...
 
const std::string SSL_CERTIFICATE_PASSWORD_PARAM = "SSLCertificatePassword"
 Engine's SSL certificate password if any. More...
 
const std::string SSL_CIPHERS_LIST_PARAM = "SSLCiphersList"
 Ciphers list configuration string. More...
 
const std::string SSL_PRIVATE_KEY_PARAM = "SSLPrivateKey"
 Engine's SSL certificate's private key file path. More...
 
const std::string SSL_PRIVATE_KEY_PASSWORD_PARAM = "SSLPrivateKeyPassword"
 Engine's SSL private key password if any. More...
 
const std::string SSL_PROTOCOLS_PARAM = "SSLProtocols"
 Engine's SSL protocols to use. More...
 
const std::string SSL_PROTOCOLS_SSLV2_VALUE = "SSLv2"
 
const std::string SSL_PROTOCOLS_SSLV3_VALUE = "SSLv3"
 
const std::string SSL_PROTOCOLS_TLSV1_1_VALUE = "TLSv1_1"
 
const std::string SSL_PROTOCOLS_TLSV1_2_VALUE = "TLSv1_2"
 
const std::string SSL_PROTOCOLS_TLSV1_VALUE = "TLSv1"
 
const std::string SSL_VALIDATE_PEER_CERT_PARAM = "SSLValidatePeerCertificate"
 Whatever client's certificate is mandatory. More...
 
const std::string THIRD_PARTY_ROUTING_PARAM = "ThirdPartyRoutingIsEnabled"
 FIX Engine has inbuilt FIX message routing capability and fully supports the "Deliver To On Behalf Of" mechanism as specified by the FIX protocol. More...
 
const std::string TIMESTAMP_UNIT_MESSAGE_STORAGE = "MessageStorage.TimestampUnit"
 This parameter sets the timestamp format for storages Valid values: millisecond - use millisecond precision in timeformat (default value) microsecond - use microsecond precision in timeformat nanosecond - use nanosecond precision in timeformat. More...
 
const std::string TIMESTAMPS_IN_LOGS_PARAM = "TimestampsInLogs"
 An option to write timestamps in the log files. More...
 
const std::string TOTAL_OUTGOING_STORAGE_MEMORY_LIMIT_PARAM = "TotalOutgoingStorageMemoryLimit"
 Specifies total amount of the memory (in MB) that active session may use. More...
 
const std::string UA_CREATE_SESSION_PARAM = "UnregisteredAcceptor.CreateSession"
 This parameter provides an option whereby FIX Engine will accept a FIX session for which it has no registered application (an acceptor). More...
 
const std::string UA_IGNORE_SEQNUM_TOO_LOW_AT_LOGON_PARAM = "UnregisteredAcceptor.IgnoreSeqNumTooLowAtLogon"
 This parameter allow to resolve seqNum too low problem at logon. More...
 
const std::string UA_MAX_MESSAGES_AMOUNT_IN_BUNCH_PARAM = "UnregisteredAcceptor.maxMessagesAmountInBunch"
 FA able to join packages that wait for sending into the socket, this parameters controls how many messages could be joined. More...
 
const std::string UA_REJECT_MESSAGE_WHILE_NO_CONNECTION_PARAM = "UnregisteredAcceptor.RejectMessageWhileNoConnection"
 When true, unregistered acceptors will reject messages in case they couldn't be sent during interval. More...
 
const std::string UA_TCP_BUFFER_DISABLED_PARAM = "UnregisteredAcceptor.tcpBufferDisabled"
 When true, the TCP buffer (Nagle algorithm) will be disabled for the unregistered acceptors. More...
 
const std::string UNREG_SESSION_STORAGE_TYPE_PARAM = "UnregisteredAcceptor.SessionStorageType"
 Default storage type of the created unregistered sessions. More...
 
const std::string UNREG_SESSION_STORAGE_TYPE_PARAM_DEP = "UnregisteredSessionStorageType"
 Default storage type of the created unregistered sessions. More...
 
const std::string V_ADDITIONAL_FIELDS_FILE_NAME_PARAM = "Validation.AdditionalFieldsFileName"
 
const std::string V_ADDITIONAL_FIELDS_PARAM = "Validation.AdditionalFields"
 
const std::string V_ALLOW_EMPTY_FIELD_VALUE_PARAM = "AllowEmptyFieldValue"
 When true, raw message may contains tags without values - they will be ignored. More...
 
const std::string V_ALLOW_ZERO_NUM_IN_GROUP_PARAM = "AllowZeroNumInGroup"
 When true, raw message may contains leading group tag with 0 value - it will be ignored. More...
 
const std::string V_CHECK_REQUIRED_GROUP_FIELDS_PARAM = "Validation.CheckRequiredGroupFields"
 This parameter controls the validation of required fields in repeating group. More...
 
const std::string V_IGNORE_UNKNOWN_FIELDS = "IgnoreUnknownFields"
 If true any field that is unknown to dictionary will be ingnored. More...
 
const std::string V_PROHIBIT_DUPLICATED_TAGS = "Validation.ProhibitDuplicatedTags"
 This parameter controls duplicate tag handling. More...
 
const std::string V_PROHIBIT_UNKNOWN_TAGS = "ProhibitUnknownTags"
 This parameter controls unknown tag handling. More...
 
const std::string V_VALIDATE_MESSAGE_PARAM = "MessageMustBeValidated"
 This parameter controls existence of required tags in application level messages. More...
 
const std::string V_VERIFY_REPERATING_GROUP_BOUNDS = "VerifyReperatingGroupBounds"
 This parameter controls repeating group size checking. More...
 
const std::string V_VERIFY_TAGS_VALUES = "VerifyTagsValues"
 This parameter controls tag values validation. More...
 
const std::string WORKER_CPU_AFFINITY = "WorkerCpuAffinity"
 Defines an affinity mask for all worker pool threads. More...
 

Detailed Description

List of all engine.properties parameters.

Variable Documentation

◆ ANCHOR_FILE_NAME

const std::string Engine::FIXPropertiesNames::ANCHOR_FILE_NAME = "AnchorFile"

◆ BACKUP_DIRECTORY_PARAM

const std::string Engine::FIXPropertiesNames::BACKUP_DIRECTORY_PARAM = "BackupDirectory"

Relative path to the backup folder.

This folder will be used for message storage files of the backup connections.

◆ CHECK_VERSION_OUTGOING_MESSAGE_PARAM

const std::string Engine::FIXPropertiesNames::CHECK_VERSION_OUTGOING_MESSAGE_PARAM = "CheckVersionOfOutgoingMessages"

This parameter is an option whereby the version of FIX protocol used for the outgoing message is validated against that of the established session.

If set to "true" then the application must use the same version of the protocol as the established session otherwise an error occurs. If set to false then the application level message will be sent to the counterparty. The recommended value is "true".

Warning
Changing this value will impact upon the performance of FIX Engine. In the development should be true. In production should be false.

◆ CONNECT_ADDRESS_PARAM

const std::string Engine::FIXPropertiesNames::CONNECT_ADDRESS_PARAM = "ConnectAddress"

Engine's local IP address to send messages from.

It is used only for multi-homed hosts If this parameter is commented or empty, the engine will send IP datagrams from any/all local addresses.

◆ CREATE_UNREGISTERED_ACCEPTOR_SESSION_PARAM

const std::string Engine::FIXPropertiesNames::CREATE_UNREGISTERED_ACCEPTOR_SESSION_PARAM = "CreateUnregisteredAcceptorSession"

This parameter provides an option whereby FIX Engine will accept a FIX session for which it has no registered application (an acceptor).

If set to "true" Engine accepts incoming connection and creates corresponding Session object. If there is no Application associated with session, all application level messages are rejected with Application Level Reject(3) message. If an application is registered behaviour is as standard. If set to false then Logon messages are ignored and incoming connection is dropped. Property is obsolete, UnregisteredAcceptor.CreateSession should be used instead.

◆ DBL_TCP_LISTEN_ADDRESSES

const std::string Engine::FIXPropertiesNames::DBL_TCP_LISTEN_ADDRESSES = "Myricom.Dbl.TcpListenAddresses"

DBL TCP listen address and port.

Format: <XXX.XXX.XXX.XXX>:<port>. Parameter is optional.

◆ DBL_USE_SOCKET_ADAPTOR

const std::string Engine::FIXPropertiesNames::DBL_USE_SOCKET_ADAPTOR = "Myricom.Dbl.UseSocketAdaptor"

This property tells how will be initialized Myricom DBL TCP API.

If true it will be used SocketAdaptor to emulate DBL API via generic sockets. Default value is false. Parameter is optional.

◆ DEBUG_LOG_SESSION_EXTRA_PARAMETERS_PARAM

const std::string Engine::FIXPropertiesNames::DEBUG_LOG_SESSION_EXTRA_PARAMETERS_PARAM = "Debug.LogSessionExtraParameters"

If this property value is true, all session parameters will be printed to the engine.log file.

◆ DICTIONARIES_FILES_LIST

const std::string Engine::FIXPropertiesNames::DICTIONARIES_FILES_LIST = "DictionariesFilesList"

This parameter contains name of the XML file with extensions of the FIX protocols.

◆ DISPATCHER_RECV_WORKERS_COUNT

const std::string Engine::FIXPropertiesNames::DISPATCHER_RECV_WORKERS_COUNT = "Dispatcher.RecvWorkersCount"

Defines number of workers to handle incoming messages.

Default value is 3

◆ DISPATCHER_RECV_WORKERS_TIMEOUT

const std::string Engine::FIXPropertiesNames::DISPATCHER_RECV_WORKERS_TIMEOUT = "Dispatcher.RecvWorkersTimeout"

Defines number of milliseconds to wait for readiness of the socket to receive data.

-1 means no polling (low CPU usage but higher latency). 0 means infinite polling without delay (decreases latency but causes 100% CPU usage). Default is -1.

◆ DISPATCHER_SEND_WORKERS_COUNT

const std::string Engine::FIXPropertiesNames::DISPATCHER_SEND_WORKERS_COUNT = "Dispatcher.SendWorkersCount"

Defines number of workers to handle outgoing messages.

Default is 1

◆ DISPATCHER_SEND_WORKERS_TIMEOUT

const std::string Engine::FIXPropertiesNames::DISPATCHER_SEND_WORKERS_TIMEOUT = "Dispatcher.SendWorkersTimeout"

Defines number of milliseconds to wait for readiness of the socket to send data.

-1 means no polling (low CPU usage but higher latency). 0 means infinite polling without delay (decreases latency but causes 100% CPU usage). Default is -1.

◆ DP_DELIVERY_TRIES_INTERVAL_PARAM

const std::string Engine::FIXPropertiesNames::DP_DELIVERY_TRIES_INTERVAL_PARAM = "DelayedProcessing.DeliveryTriesInterval"

This parameter specifies the time interval between attempts to deliver an application level message to a registered client application in the event the application does not confirm receipt and operation upon the message.

The value is specified in milliseconds. The value must be integer and greater than 0. This parameter is required only if the DelayedProcessing.MaxDeliveryTries parameter is specified.

◆ DP_MAX_DELIVARY_TRIES_PARAM

const std::string Engine::FIXPropertiesNames::DP_MAX_DELIVARY_TRIES_PARAM = "DelayedProcessing.MaxDeliveryTries"

This parameter specifies the number of attempts that will be made to deliver an application level message to the registered client application.

If this value is exceeded then the session will be closed with the logout reason "Application not available". The recommended value is 10. The value must be integer and not negative. This parameter is optional.

◆ DUPLICATE_RESEND_REQUEST_LIMIT_PARAM

const std::string Engine::FIXPropertiesNames::DUPLICATE_RESEND_REQUEST_LIMIT_PARAM = "DuplicateResendRequestLimit"

Specified how much same ResendRequests received before Application::onResendRequestLoop is called.

This option is disabled if value is less than 2.

◆ ENABLE_AUTO_SWITCH_TO_BACKUP_CONNECTION_PARAM

const std::string Engine::FIXPropertiesNames::ENABLE_AUTO_SWITCH_TO_BACKUP_CONNECTION_PARAM = "EnableAutoSwitchToBackupConnection"

◆ ENABLE_CYCLIC_SWITCH_BACKUP_CONNECTION

const std::string Engine::FIXPropertiesNames::ENABLE_CYCLIC_SWITCH_BACKUP_CONNECTION = "EnableCyclicSwitchBackupConnection"

◆ ENABLE_DNS_ENTRY_SPOOFING_DETECTION

const std::string Engine::FIXPropertiesNames::ENABLE_DNS_ENTRY_SPOOFING_DETECTION = "EnableDnsEntrySpoofingDetection"

When it's set to true there is being enabled backward resolve based DNS entry spoofing detection mechanism in DNS related functions.

Note
this option is disabled by default
Attention
If parameter is enabled, user should use Fully Qualified Domain Name (FQDN) or IP addresses as configuration/function parameters (e.g. 'workstation1.epam.com' instead of 'workstation1'). Otherwise errors about DNS spoofing will be reported.

◆ ENABLE_INCREMENTAL_LOG_FILE_CREATION_PARAM

const std::string Engine::FIXPropertiesNames::ENABLE_INCREMENTAL_LOG_FILE_CREATION_PARAM = "EnableIncrementalLogFileCreation"

Setting property "true" will reserve 10Mb of disc space for logging.

If log reaches 10Mbs, another 10Mbs will be reserved and so on. When property is "true" FixAntenna performance is greatly increased.

◆ ENCRYPTION_CONFIG_FILE_PARAM

const std::string Engine::FIXPropertiesNames::ENCRYPTION_CONFIG_FILE_PARAM = "EncryptionConfigFile"

Encryption config file.

◆ ENGINE_ROOT_PARAM

const std::string Engine::FIXPropertiesNames::ENGINE_ROOT_PARAM = "EngineRoot"

The top of the directory tree under which the engine's configuration, and log files are kept.

Do NOT add a slash at the end of the directory path.

◆ EXTRA_SAFE_MODE_PARAM

const std::string Engine::FIXPropertiesNames::EXTRA_SAFE_MODE_PARAM = "ExtraSafeMode"

If this parameter is true than file streams are flushed after each I/O operation.

Warning
Changing this value will impact upon the performance of FIX Engine. In the development and in production should be true.

◆ FAILOVER_COMMAND_PORT_PARAM

const std::string Engine::FIXPropertiesNames::FAILOVER_COMMAND_PORT_PARAM = "FailOver.CommandPort"

◆ FAILOVER_HOST_PARAM

const std::string Engine::FIXPropertiesNames::FAILOVER_HOST_PARAM = "FailOver.Host"

◆ FAILOVER_IS_PRIMARY_PARAM

const std::string Engine::FIXPropertiesNames::FAILOVER_IS_PRIMARY_PARAM = "FailOver.IsPrimary"

◆ FAILOVER_MODE_PARAM

const std::string Engine::FIXPropertiesNames::FAILOVER_MODE_PARAM = "FailOver.Mode"

◆ FAILOVER_PORT_PARAM

const std::string Engine::FIXPropertiesNames::FAILOVER_PORT_PARAM = "FailOver.Port"

◆ FORCE_SEQNUM_RESET_PARAM

const std::string Engine::FIXPropertiesNames::FORCE_SEQNUM_RESET_PARAM = "ForceSeqNumReset"

This parameter allow to automatically resolve sequence gap problem.

When mode is ON session uses 141(ResetSeqNumFlag) tag in sending/confirming Logon message to reset SeqNum at the initiator or acceptor. Valid values:

  • "0" or "false" - Disable ForceSeqNumReset mode
  • "1" or "true" - Enable SeqNum reset at first time of session initiation
  • "2" - Enable SeqNum reset for every session initiation

◆ FORCE_SEQNUM_RESET_VALUE_ALWAYS

const std::string Engine::FIXPropertiesNames::FORCE_SEQNUM_RESET_VALUE_ALWAYS = "ALWAYS"

Value of the ForceSeqNumReset parameter.

  • "2" - Enable SeqNum reset for every session initiation

◆ FORCE_SEQNUM_RESET_VALUE_FALSE

const std::string Engine::FIXPropertiesNames::FORCE_SEQNUM_RESET_VALUE_FALSE = "false"

Value of the ForceSeqNumReset parameter.

  • "0" or "false" - Disable ForceSeqNumReset mode

◆ FORCE_SEQNUM_RESET_VALUE_NA

const std::string Engine::FIXPropertiesNames::FORCE_SEQNUM_RESET_VALUE_NA = "NA"

Value of the ForceSeqNumReset parameter.

  • Not defined value.

◆ FORCE_SEQNUM_RESET_VALUE_OFF

const std::string Engine::FIXPropertiesNames::FORCE_SEQNUM_RESET_VALUE_OFF = "OFF"

Value of the ForceSeqNumReset parameter.

  • "0" or "false" - Disable ForceSeqNumReset mode

◆ FORCE_SEQNUM_RESET_VALUE_ON

const std::string Engine::FIXPropertiesNames::FORCE_SEQNUM_RESET_VALUE_ON = "ON"

Value of the ForceSeqNumReset parameter.

  • "1" or "true" - Enable SeqNum reset at first time of session initiation

◆ FORCE_SEQNUM_RESET_VALUE_TRUE

const std::string Engine::FIXPropertiesNames::FORCE_SEQNUM_RESET_VALUE_TRUE = "true"
  • "1" or "true" - Enable SeqNum reset at first time of session initiation

◆ HELPER_CPU_AFFINITY

const std::string Engine::FIXPropertiesNames::HELPER_CPU_AFFINITY = "HelperCpuAffinity"

Defines an affinity mask for dispatcher and other auxiliary threads threads.

Default value is 0

◆ IDX_INCREMENT_SIZE_PARAM

const std::string Engine::FIXPropertiesNames::IDX_INCREMENT_SIZE_PARAM = "Persistents.IdxIncrementSize"

Specifies amount of memory in bytes reserved for memory mapped file message storage for *.idx file It defines how FIX Antenna reserves space on the HDD for PersistentMM (in any cases) and Persistent (if EnableIncrementalLogFileCreation is ON).

It is recommended to set large enough value to minimize number of resizes during the storage life time. Each resize can cause latency spike.

Warning
Changing this value will impact upon the performance of FIX Engine.

◆ INDEX_REBUILD_ENABLED_PARAM

const std::string Engine::FIXPropertiesNames::INDEX_REBUILD_ENABLED_PARAM = "MessageStorage.IndexRebuildEnabled"

If this parameter is true, FIX Engine will try to restore index file from log file in case when index file is missed or corrupted This parameter is optional, default value is false.

Note
Please be carefully enabling this property, restoring process uses some heuristic algorithms, and some data(not messages) could be missed

◆ INDEX_REBUILD_REQUIRE_REJECT_FLAG

const std::string Engine::FIXPropertiesNames::INDEX_REBUILD_REQUIRE_REJECT_FLAG = "MessageStorage.RequireRejectFlagSupport"

If this option is enabled, FIX Engine will not rebuild index files for message storages, that does not support embedded Reject Flag Marker This parameter is optional, default value is true.

◆ INTRADAY_LOGOUT_TOLERANCE_PARAM

const std::string Engine::FIXPropertiesNames::INTRADAY_LOGOUT_TOLERANCE_PARAM = "IntradayLogoutTolerance"

An option not to reset sequence numbers after Logout.

Logout sender should initiate session recovery by sending Logon message with SeqNum = <last outgoing="" seqnum>=""> + 1; expecting reply Logon with SeqNum = <last incoming="" seqnum>=""> + 1. If a gap is detected, standard message recovery or gap filling process takes place.

◆ IS_FORWARDING_FIXMESSAGES_TO_LOG

const std::string Engine::FIXPropertiesNames::IS_FORWARDING_FIXMESSAGES_TO_LOG = "IsForwardingFixMessagesToLog"

This parameter for forwarding fix messages to log system if set to true then incoming/outgoing fix messages add in log system with level UNFO if set to false then incoming/outgoing fix messages don't add in log system.

default value is "false"

◆ KEEP_MILLISECONDS_IN_UTCTIME_FIELDS

const std::string Engine::FIXPropertiesNames::KEEP_MILLISECONDS_IN_UTCTIME_FIELDS = "KeepMillisecondsInUTCTimeFields"

Defines how to serialize UTCTimestamp or UTCTimeOnly field values: 0 - default mode - if the value of milliseconds is not equal to 0 then it will be serialized.

1 - always serialize milliseconds 2 - always truncate milliseconds By default this parameter is 0

Note
It is a global option for FixEngine.
It works only when a value is passed as Engine::UTCTimestamp or Engine::UTCTimeOnly.

◆ LICENSE_FILE_PARAM

const std::string Engine::FIXPropertiesNames::LICENSE_FILE_PARAM = "LicenseFile"

The license file path.

◆ LISTEN_ADDRESS_PARAM

const std::string Engine::FIXPropertiesNames::LISTEN_ADDRESS_PARAM = "ListenAddress"

Engine's local IP address to bind to.

It can be used on a multi-homed host for a FIX Engine that will only accept connect requests to one of its addresses. If this parameter is commented or empty, the engine will accept connections to any/all local addresses.

◆ LISTEN_PORT_IN_DISABLED

int const Engine::FIXPropertiesNames::LISTEN_PORT_IN_DISABLED = -2

◆ LISTEN_PORT_NA

int const Engine::FIXPropertiesNames::LISTEN_PORT_NA = -1

◆ LISTEN_PORT_NETWORK_DISABLED

int const Engine::FIXPropertiesNames::LISTEN_PORT_NETWORK_DISABLED = 0

◆ LISTEN_PORT_PARAM

const std::string Engine::FIXPropertiesNames::LISTEN_PORT_PARAM = "ListenPort"

Engine's listen port.

Supports multiple values delimited by comma. Parameter is optional.

◆ LISTEN_SSL_PORT_PARAM

const std::string Engine::FIXPropertiesNames::LISTEN_SSL_PORT_PARAM = "ListenSSLPort"

Engine's listen SSL port.

Supports multiple values delimited by comma. Parameter is optional.

◆ LOG_CYCLING_PARAM

const std::string Engine::FIXPropertiesNames::LOG_CYCLING_PARAM = "Log.Cycling"

◆ LOG_DEBUG_IS_ON_PARAM

const std::string Engine::FIXPropertiesNames::LOG_DEBUG_IS_ON_PARAM = "Log.DebugIsOn"

◆ LOG_DEVICE_PARAM

const std::string Engine::FIXPropertiesNames::LOG_DEVICE_PARAM = "Log.Device"

◆ LOG_DIRECTORY_PARAM

const std::string Engine::FIXPropertiesNames::LOG_DIRECTORY_PARAM = "LogDirectory"

This property is the path of the directory in which the logs for all incoming (if LogIncomingMessages is set to "true") and outgoing FIX messages are stored.

It is possible to specify a path related to the EngineRoot directory. For example if LogDirectory is set to "logs" then the real path is /logs. The specified directory must exist.

◆ LOG_ERROR_IS_ON_PARAM

const std::string Engine::FIXPropertiesNames::LOG_ERROR_IS_ON_PARAM = "Log.ErrorIsOn"

◆ LOG_EVENT_LOG_SOURCE

const std::string Engine::FIXPropertiesNames::LOG_EVENT_LOG_SOURCE = "Log.EventLog.EventSource"

◆ LOG_FATAL_IS_ON_PARAM

const std::string Engine::FIXPropertiesNames::LOG_FATAL_IS_ON_PARAM = "Log.FatalIsOn"

◆ LOG_FILE_AUTOFLUSH_PARAM

const std::string Engine::FIXPropertiesNames::LOG_FILE_AUTOFLUSH_PARAM = "Log.File.AutoFlush"

◆ LOG_FILE_BACKUP_TIME_PARAM

const std::string Engine::FIXPropertiesNames::LOG_FILE_BACKUP_TIME_PARAM = "Log.File.Backup.Time"

◆ LOG_FILE_LOCKED_PARAM

const std::string Engine::FIXPropertiesNames::LOG_FILE_LOCKED_PARAM = "Log.File.Locked"

◆ LOG_FILE_NAME_PARAM

const std::string Engine::FIXPropertiesNames::LOG_FILE_NAME_PARAM = "LogFileName"

Engine's log file name.

If this parameter is commented or empty, the 'engine.log' will be used.

◆ LOG_FILE_RECREATE_PARAM

const std::string Engine::FIXPropertiesNames::LOG_FILE_RECREATE_PARAM = "Log.File.Recreate"

◆ LOG_FILE_ROOT_DIR_PARAM

const std::string Engine::FIXPropertiesNames::LOG_FILE_ROOT_DIR_PARAM = "Log.File.RootDir"

◆ LOG_FILE_ROTATE_PARAM

const std::string Engine::FIXPropertiesNames::LOG_FILE_ROTATE_PARAM = "Log.File.Rotate"

◆ LOG_FILE_TIMEZONE_PARAM

const std::string Engine::FIXPropertiesNames::LOG_FILE_TIMEZONE_PARAM = "Log.File.TimeZone"

◆ LOG_INCOMING_MESSAGES_PARAM

const std::string Engine::FIXPropertiesNames::LOG_INCOMING_MESSAGES_PARAM = "LogIncomingMessages"

This property provides an option to log incoming FIX messages (those received) from a counterparty FIX Engine.

They will be stored in the directory specified by the LogDirectory parameter in a file with extension "in".

Warning
Changing this value will impact upon the performance of FIX Engine. In the development should be true. In production should be false.

◆ LOG_INCREMENT_SIZE_PARAM

const std::string Engine::FIXPropertiesNames::LOG_INCREMENT_SIZE_PARAM = "Persistents.LogIncrementSize"

Specifies amount of memory in bytes reserved for memory mapped file message storage for *.out/*.in files.

It defines how FIX Antenna reserves space on the HDD for PersistentMM (in any cases) and Persistent (if EnableIncrementalLogFileCreation is ON). It is recommended to set large enough value to minimize number of resizes during the storage life time. Each resize can cause latency spike.

Warning
Changing this value will impact upon the performance of FIX Engine.

◆ LOG_LOG_FILE_NAME_PARAM

const std::string Engine::FIXPropertiesNames::LOG_LOG_FILE_NAME_PARAM = "Log.File.Name"

◆ LOG_NOTE_IS_ON_PARAM

const std::string Engine::FIXPropertiesNames::LOG_NOTE_IS_ON_PARAM = "Log.NoteIsOn"

◆ LOG_WARN_IS_ON_PARAM

const std::string Engine::FIXPropertiesNames::LOG_WARN_IS_ON_PARAM = "Log.WarnIsOn"

◆ LOGON_TIME_FRAME_PARAM

const std::string Engine::FIXPropertiesNames::LOGON_TIME_FRAME_PARAM = "LogonTimeFrame"

This parameter sets the time period after which a session is non-gracefully terminated if a response is not received to a first "Logon" message (message type A).

The corresponding Logout message is sent to the counterparty. This value is in seconds. The recommended value is 30 seconds for dedicated connections or private networks. Trading connections via the internet will require calibration. If it is set to "0", then the time period is unlimited. The value must be integer and not negative.

◆ LOGOUT_TIME_FRAME_PARAM

const std::string Engine::FIXPropertiesNames::LOGOUT_TIME_FRAME_PARAM = "LogoutTimeFrame"

This parameter sets the time period after which a session is automatically terminated if a response is not received to a "Logout message" (message type 5).

This value is in seconds. The recommended value is 10 seconds for dedicated connections or private networks. Trading connections via the internet will require calibration. The value must be integer and greater than 0.

◆ M_ADMIN_SEESION_DEF_DISABLE_TCP_BUFFER_PARAM

const std::string Engine::FIXPropertiesNames::M_ADMIN_SEESION_DEF_DISABLE_TCP_BUFFER_PARAM = "Monitoring.AdminSessionDef.DisableTCPBuffer"

When true TCP buffer (Nagle algorithm) will be disabled for session.

◆ M_ADMIN_SEESION_DEF_ENCRYPT_METHOD_PARAM

const std::string Engine::FIXPropertiesNames::M_ADMIN_SEESION_DEF_ENCRYPT_METHOD_PARAM = "Monitoring.AdminSessionDef.EncryptMethod"

The expected value of the encryption method.

◆ M_ADMIN_SEESION_DEF_FORCE_SEQNUM_RESET_PARAM

const std::string Engine::FIXPropertiesNames::M_ADMIN_SEESION_DEF_FORCE_SEQNUM_RESET_PARAM = "Monitoring.AdminSessionDef.ForceSeqNumResetMode"

Force SeqNum reset mode.

An option to use 141 tag in Logon message to reset sequence number.

◆ M_ADMIN_SEESION_DEF_IGNORE_SEQNUM_TOO_LOW_LOGON_PARAM

const std::string Engine::FIXPropertiesNames::M_ADMIN_SEESION_DEF_IGNORE_SEQNUM_TOO_LOW_LOGON_PARAM = "Monitoring.AdminSessionDef.IgnoreSeqNumTooLowAtLogon"

When true, session ignore 'SeqNum too low' at incoming Logon message and continue with received SeqNum.

◆ M_ADMIN_SEESION_DEF_INTERDAY_LOGOUT_TOLERANCE_PARAM

const std::string Engine::FIXPropertiesNames::M_ADMIN_SEESION_DEF_INTERDAY_LOGOUT_TOLERANCE_PARAM = "Monitoring.AdminSessionDef.IntradayLogoutToleranceMode"

Intraday logout tolerance mode.

An option to reset or not to reset sequence numbers after Logout.

◆ M_ADMIN_SEESION_DEF_MAX_MESSAGES_IN_BUNCH_PARAM

const std::string Engine::FIXPropertiesNames::M_ADMIN_SEESION_DEF_MAX_MESSAGES_IN_BUNCH_PARAM = "Monitoring.AdminSessionDef.MaxMessagesAmountInBunch"

Enqueued outgoing messages could merged and sent as a single buffer.

This parameter controls how many messages could be merged into the bunch. The 0 means infinite amount.

◆ M_ADMIN_SEESION_DEF_PASSWORD_PARAM

const std::string Engine::FIXPropertiesNames::M_ADMIN_SEESION_DEF_PASSWORD_PARAM = "Monitoring.AdminSessionDef.Password"

The expected value of the Password (Tag 554) field in the incoming Logon message.

If the real value is not equal to the expected one then the session is disconnected without sending a message and the error condition is generated in the log output.

◆ M_ADMIN_SEESION_DEF_SENDER_LOCATION_ID_PARAM

const std::string Engine::FIXPropertiesNames::M_ADMIN_SEESION_DEF_SENDER_LOCATION_ID_PARAM = "Monitoring.AdminSessionDef.SenderLocationID"

SenderLocationID (tag 142) - assigned value used to identify specific message originator's location (i.e.

geographic location and/or desk, trader).

◆ M_ADMIN_SEESION_DEF_SOCKET_OP_PRIORITY_PARAM

const std::string Engine::FIXPropertiesNames::M_ADMIN_SEESION_DEF_SOCKET_OP_PRIORITY_PARAM = "Monitoring.AdminSessionDef.SocketOpPriority"

Priority of the socket SendReceive operations.

Valid values:

  • EVEN (default) - share worker thread among all session in the Engine
  • AGGRESSIVE_SEND - use dedicated thread to send outgoing messages
  • AGGRESSIVE_RECEIVE - use dedicated thread to send outgoing messages

◆ M_ADMIN_SEESION_DEF_SOURCE_IP_PARAM

const std::string Engine::FIXPropertiesNames::M_ADMIN_SEESION_DEF_SOURCE_IP_PARAM = "Monitoring.AdminSessionDef.SourceIPaddress"

The expected value of the source IP address.

If the real value is not equal to the expected one then the session is disconnected without sending a message and the error condition is generated in the log output.

◆ M_ADMIN_SEESION_DEF_TARGET_LOCATION_ID_PARAM

const std::string Engine::FIXPropertiesNames::M_ADMIN_SEESION_DEF_TARGET_LOCATION_ID_PARAM = "Monitoring.AdminSessionDef.TargetLocationID"

TargetLocationID_ (tag 143) - assigned value used to identify specific message destination's location (i.e.

geographic location and/or desk, trader).

◆ M_ADMIN_SEESION_DEF_TARGET_SUB_ID_PARAM

const std::string Engine::FIXPropertiesNames::M_ADMIN_SEESION_DEF_TARGET_SUB_ID_PARAM = "Monitoring.AdminSessionDef.TargetSubID"

TargetSubID (tag 57) - assigned value used to identify specific individual or unit intended to receive message.

◆ M_ADMIN_SEESION_DEF_USER_NAME_PARAM

const std::string Engine::FIXPropertiesNames::M_ADMIN_SEESION_DEF_USER_NAME_PARAM = "Monitoring.AdminSessionDef.Username"

The expected value of the Username (Tag 553) field in the incoming Logon message.

If the real value is not equal to the expected one then the session is disconnected without sending a message and the error condition is generated in the log output.

◆ M_LISTEN_PORT_PARAM

const std::string Engine::FIXPropertiesNames::M_LISTEN_PORT_PARAM = "Monitoring.ListenPort"

The engine TCP listen port that is enabled for administrative sessions If port is configured it will be added to set of engine listen ports and administrative sessions will be accepted on this port only If not exists or empty common engine listen ports are used to accept administrative sessions.

◆ MEASURING_ENABLE_PARAM

const std::string Engine::FIXPropertiesNames::MEASURING_ENABLE_PARAM = "Measuring.Enable"

◆ MESSAGE_TIME_TO_LIVE_PARAM

const std::string Engine::FIXPropertiesNames::MESSAGE_TIME_TO_LIVE_PARAM = "MessageTimeToLive"

This parameter sets the time period after which a message rejecting is starting while session isn't exists.

Parameter isn't required. Value is specified in milliseconds (seconds*10-3), must be integer and > 0.

◆ MONITORING_ENABLE_PARAM

const std::string Engine::FIXPropertiesNames::MONITORING_ENABLE_PARAM = "Monitoring.Enable"

Enables/disables Engine monitoring.

◆ NUMBER_OF_WORKERS_PARAM

const std::string Engine::FIXPropertiesNames::NUMBER_OF_WORKERS_PARAM = "NumberOfWorkers"

Number of threads that serve FIX sessions (heartbeat generation/check, message rejecting, message delay delivering, etc) On Linux the recommended value is 2.

On other platforms the recommended value is 10. The value must be integer and greater than zero.

Warning
Changing this value will impact upon the performance of FIX Engine.

◆ OUT_OF_SEQUENCE_MESSAGES_QUEUE_SIZE

const std::string Engine::FIXPropertiesNames::OUT_OF_SEQUENCE_MESSAGES_QUEUE_SIZE = "OutOfSequenceMessagesStrategy.QueueSize"

This parameter sets size temporary map for processing out of sequence messages in strategy "Queue" default value is "2000".

◆ OUT_OF_SEQUENCE_MESSAGES_STRATEGY

const std::string Engine::FIXPropertiesNames::OUT_OF_SEQUENCE_MESSAGES_STRATEGY = "OutOfSequenceMessagesStrategy"

This parameter sets strategy for out of sequence messages Valid values: RequestAlways - send resend request on any out of sequence message RequestOnce - Send resend request on gap.

Suppress new resend request if gap not closed Queue - Use temporary queue for storing out of sequence messages and processing them after closing gap IgnoreGap - Send resend request on gap and processing out of sequence messages default value is "RequestAlways"

◆ OUTGOING_MESSAGE_STORAGE_SIZE_PARAM

const std::string Engine::FIXPropertiesNames::OUTGOING_MESSAGE_STORAGE_SIZE_PARAM = "OutgoingMessagesStorageSize"

This parameter defines the upper limit to the number of outgoing messages that are resent in the event of a Resend Request.

The recommended value is 20000 if no data on mean activity is known.

Warning
Changing this value will impact upon the performance of FIX Engine. Large storage increases application working set.

◆ P_DDOS_PROTECTION_ENABLE_PARAM

const std::string Engine::FIXPropertiesNames::P_DDOS_PROTECTION_ENABLE_PARAM = "ProtectionTCP.Enabled"

Enables/disables protection from DDoS attacks.

◆ P_DDOS_PROTECTION_SIZE_BUFFER_MAX_PARAM

const std::string Engine::FIXPropertiesNames::P_DDOS_PROTECTION_SIZE_BUFFER_MAX_PARAM = "ProtectionTCP.SizeBufferMax"

Maximum size of buffer allocated for incoming message.

Connections that exceed the limit will be closed. 0 means maximum size is not limited.

◆ P_DDOS_PROTECTION_SIZE_WAIT_HOST_MAX_PARAM

const std::string Engine::FIXPropertiesNames::P_DDOS_PROTECTION_SIZE_WAIT_HOST_MAX_PARAM = "ProtectionTCP.SizeWaitHostMax"

Maximum number of incoming TCP connections waiting logon from one host.

Connections that exceed the limit will be closed. 0 means maximum number is not limited.

◆ P_DDOS_PROTECTION_WAIT_LOGON_PARAM

const std::string Engine::FIXPropertiesNames::P_DDOS_PROTECTION_WAIT_LOGON_PARAM = "ProtectionTCP.WaitLogon"

Maximum waiting time in milliseconds for first FIX message from new incoming TCP connection.

If message is not received connection will be closed. 0 means waiting time is not limited.

◆ PARSERS_NAMES_LIST

const std::string Engine::FIXPropertiesNames::PARSERS_NAMES_LIST = "AdditionalParsersList"

This parameter defines custom raw FIX parser list delimeted by semicolon.

Format of the value: [PARSER_NAME@][FIXT_PROTOCOL1:APP_PROTCOL1,[APP_PROTCOL1[, ...]] | [APP_PROTCOL1] ; ... Examples of one entry. Entries can be combined with semicolon to define more than one parser:

  • FIX44
  • FIXT11:FIX50SP2
  • FIXT11:FIX50SP2,FIX50SP1
  • MyFixParser:FIX50SP2,FIX50SP1

◆ REASONABLE_TRANSMISSION_TIME_PARAM

const std::string Engine::FIXPropertiesNames::REASONABLE_TRANSMISSION_TIME_PARAM = "ReasonableTransmissionTime"

This parameter specifies the delta (increment) to the Heartbeat interval between a TestRequest message being sent by FIX Engine and a Response Heartbeat being received.

The session attains a "telecommunication failed state" if no Response Heartbeat message is received after the normal Heartbeat interval plus delta. For example if no message (application or session level) is received during the Heartbeat interval then Engine sends a TestRequest message. If the required Response Heartbeat message is not received during Heartbeat interval plus Delta then the session moves to the state "Telecommunication link failed". This parameter is specified in (Heartbeat Interval/100). The recommended value is twenty percent.

◆ RECONNECT_INTERVAL_PARAM

const std::string Engine::FIXPropertiesNames::RECONNECT_INTERVAL_PARAM = "Reconnect.Interval"

This parameter specifies the time interval between reconnection attempts in order to restore a communications link.

This value is specified in milliseconds (seconds*10-3). The recommended value is 1000 for dedicated connections and private networks. Internet connections require calibration. The value must be integer and greater than 0.

◆ RECONNECT_MAX_TRIES_PARAM

const std::string Engine::FIXPropertiesNames::RECONNECT_MAX_TRIES_PARAM = "Reconnect.MaxTries"

This parameter specifies the number of attempts to restore the session.

The session is considered as restored if the telecommunication link was restored and the exchange of Logon messages was successful. If it is set to "-1", then the number of attempts is unlimited. This value is integer.

◆ RESEND_MESSAGES_BLOCK_SIZE_PARAM

const std::string Engine::FIXPropertiesNames::RESEND_MESSAGES_BLOCK_SIZE_PARAM = "ResendMessagesBlockSize"

Resend Request resend messages by blocks.

This parameter defines how many messages proceed in block. 0 - all messages will be resend in one block. By default parameter is 1000. The value must be integer and not less than 0.

◆ RESET_SEQNUM_AFTER_24_HOURS_PARAM

const std::string Engine::FIXPropertiesNames::RESET_SEQNUM_AFTER_24_HOURS_PARAM = "ResetSeqNumAfter24hours"

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).

This parameter is optional, the default value is false.

Note
This option does not affect sessions which use version 4.0 of the FIX protocol.

◆ SESSION_STORAGE_TYPE_PARAM_DEP2

const std::string Engine::FIXPropertiesNames::SESSION_STORAGE_TYPE_PARAM_DEP2 = "SessionStorageType"

Default storage type of the created unregistered sessions.

By default persistent storage type used. Use "transient" value to use transient storage for the sessions.

Deprecated:
Use UnregisteredAcceptor.SessionStorageType instead

◆ SLICED_STORAGE_BACKUP_DIRECTORY

const std::string Engine::FIXPropertiesNames::SLICED_STORAGE_BACKUP_DIRECTORY = "SplitPersistentMsgStorage.BackupDir"

This property is the path of the directory, where sliced message storage will search for log files in case they not found in primary location.

It is user responsibility to move files from primary location to backup. Default value is empty - backup path disabled.

See also
Engine::splitPersistent_storageType

◆ SLICED_STORAGE_MAX_FILESIZE

const std::string Engine::FIXPropertiesNames::SLICED_STORAGE_MAX_FILESIZE = "SplitPersistentMsgStorage.MaxSliceSize"

Specifies maximum size of one slice for sliced message storage.

Note
Storage slices are created with step, specified with Persistents.LogIncrementSize parameter value. If MaxSliceSize value is no multiple of Persistents.LogIncrementSize, result file size will be less, than specified. If value is less than LogIncrementSize, LogIncrementSize value will be used Recommended value: any multiple of Persistents.LogIncrementSize Default value is 500000000 - 500Mb
See also
Engine::splitPersistent_storageType

◆ SSL_CA_CERTIFICATE_PARAM

const std::string Engine::FIXPropertiesNames::SSL_CA_CERTIFICATE_PARAM = "SSLCACertificate"

Engine's SSL CA certificate file path.

Parameter is optional.

◆ SSL_CERTIFICATE_PARAM

const std::string Engine::FIXPropertiesNames::SSL_CERTIFICATE_PARAM = "SSLCertificate"

Engine's SSL certificate file path.

Parameter is mandatory if ListenSSLPort is not empty.

◆ SSL_CERTIFICATE_PASSWORD_PARAM

const std::string Engine::FIXPropertiesNames::SSL_CERTIFICATE_PASSWORD_PARAM = "SSLCertificatePassword"

Engine's SSL certificate password if any.

Parameter is optional

◆ SSL_CIPHERS_LIST_PARAM

const std::string Engine::FIXPropertiesNames::SSL_CIPHERS_LIST_PARAM = "SSLCiphersList"

Ciphers list configuration string.

Parameter is optional.

◆ SSL_PRIVATE_KEY_PARAM

const std::string Engine::FIXPropertiesNames::SSL_PRIVATE_KEY_PARAM = "SSLPrivateKey"

Engine's SSL certificate's private key file path.

Parameter is conditionaly optional. It is optional if privete key is embeded into certificate file(.pfx, possibly .pem).

◆ SSL_PRIVATE_KEY_PASSWORD_PARAM

const std::string Engine::FIXPropertiesNames::SSL_PRIVATE_KEY_PASSWORD_PARAM = "SSLPrivateKeyPassword"

Engine's SSL private key password if any.

Parameter is optional.

◆ SSL_PROTOCOLS_PARAM

const std::string Engine::FIXPropertiesNames::SSL_PROTOCOLS_PARAM = "SSLProtocols"

Engine's SSL protocols to use.

Parameter is mandatory. it is a comma separated list of protocols to use. Valid values are SSLv2, SSLv3, TLSv1, TLSv1_1, TLSv1_2.

◆ SSL_PROTOCOLS_SSLV2_VALUE

const std::string Engine::FIXPropertiesNames::SSL_PROTOCOLS_SSLV2_VALUE = "SSLv2"

◆ SSL_PROTOCOLS_SSLV3_VALUE

const std::string Engine::FIXPropertiesNames::SSL_PROTOCOLS_SSLV3_VALUE = "SSLv3"

◆ SSL_PROTOCOLS_TLSV1_1_VALUE

const std::string Engine::FIXPropertiesNames::SSL_PROTOCOLS_TLSV1_1_VALUE = "TLSv1_1"

◆ SSL_PROTOCOLS_TLSV1_2_VALUE

const std::string Engine::FIXPropertiesNames::SSL_PROTOCOLS_TLSV1_2_VALUE = "TLSv1_2"

◆ SSL_PROTOCOLS_TLSV1_VALUE

const std::string Engine::FIXPropertiesNames::SSL_PROTOCOLS_TLSV1_VALUE = "TLSv1"

◆ SSL_VALIDATE_PEER_CERT_PARAM

const std::string Engine::FIXPropertiesNames::SSL_VALIDATE_PEER_CERT_PARAM = "SSLValidatePeerCertificate"

Whatever client's certificate is mandatory.

Decline clients without certificate if true. Parameter is optional. Default is false.

◆ THIRD_PARTY_ROUTING_PARAM

const std::string Engine::FIXPropertiesNames::THIRD_PARTY_ROUTING_PARAM = "ThirdPartyRoutingIsEnabled"

FIX Engine has inbuilt FIX message routing capability and fully supports the "Deliver To On Behalf Of" mechanism as specified by the FIX protocol.

If this parameter is set to "true" then Engine will redirect FIX messages automatically to other FIX sessions it maintains if OnBehalfOfCompID field in the message is defined. If this parameter is set to "false" Engine directs all messages received to the client application.

◆ TIMESTAMP_UNIT_MESSAGE_STORAGE

const std::string Engine::FIXPropertiesNames::TIMESTAMP_UNIT_MESSAGE_STORAGE = "MessageStorage.TimestampUnit"

This parameter sets the timestamp format for storages Valid values: millisecond - use millisecond precision in timeformat (default value) microsecond - use microsecond precision in timeformat nanosecond - use nanosecond precision in timeformat.

◆ TIMESTAMPS_IN_LOGS_PARAM

const std::string Engine::FIXPropertiesNames::TIMESTAMPS_IN_LOGS_PARAM = "TimestampsInLogs"

An option to write timestamps in the log files.

This parameter is optional, the default value is true.

Warning
Changing this value will impact upon the performance of FIX Engine. In the development should be true. In production should be false.

◆ TOTAL_OUTGOING_STORAGE_MEMORY_LIMIT_PARAM

const std::string Engine::FIXPropertiesNames::TOTAL_OUTGOING_STORAGE_MEMORY_LIMIT_PARAM = "TotalOutgoingStorageMemoryLimit"

Specifies total amount of the memory (in MB) that active session may use.

0 - means infinite. When limit is reached, the "hardest" sessions will be closed non-gracefully.

◆ UA_CREATE_SESSION_PARAM

const std::string Engine::FIXPropertiesNames::UA_CREATE_SESSION_PARAM = "UnregisteredAcceptor.CreateSession"

This parameter provides an option whereby FIX Engine will accept a FIX session for which it has no registered application (an acceptor).

If set to "true" Engine accepts incoming connection and creates corresponding Session object. If there is no Application associated with session, all application level messages are rejected with Application Level Reject(3) message. If an application is registered behavior is as standard. If set to false then Logon messages are ignored and incoming connection is dropped.

◆ UA_IGNORE_SEQNUM_TOO_LOW_AT_LOGON_PARAM

const std::string Engine::FIXPropertiesNames::UA_IGNORE_SEQNUM_TOO_LOW_AT_LOGON_PARAM = "UnregisteredAcceptor.IgnoreSeqNumTooLowAtLogon"

This parameter allow to resolve seqNum too low problem at logon.

When it true - session continue with received seqNum.

◆ UA_MAX_MESSAGES_AMOUNT_IN_BUNCH_PARAM

const std::string Engine::FIXPropertiesNames::UA_MAX_MESSAGES_AMOUNT_IN_BUNCH_PARAM = "UnregisteredAcceptor.maxMessagesAmountInBunch"

FA able to join packages that wait for sending into the socket, this parameters controls how many messages could be joined.

0 means infinite. Value should be less than 1000000.

◆ UA_REJECT_MESSAGE_WHILE_NO_CONNECTION_PARAM

const std::string Engine::FIXPropertiesNames::UA_REJECT_MESSAGE_WHILE_NO_CONNECTION_PARAM = "UnregisteredAcceptor.RejectMessageWhileNoConnection"

When true, unregistered acceptors will reject messages in case they couldn't be sent during interval.

◆ UA_TCP_BUFFER_DISABLED_PARAM

const std::string Engine::FIXPropertiesNames::UA_TCP_BUFFER_DISABLED_PARAM = "UnregisteredAcceptor.tcpBufferDisabled"

When true, the TCP buffer (Nagle algorithm) will be disabled for the unregistered acceptors.

Otherwise, TCP may join and enqueue small packages until timeout ends.

◆ UNREG_SESSION_STORAGE_TYPE_PARAM

const std::string Engine::FIXPropertiesNames::UNREG_SESSION_STORAGE_TYPE_PARAM = "UnregisteredAcceptor.SessionStorageType"

Default storage type of the created unregistered sessions.

By default persistent storage type used. Use "transient" value to use transient storage for the sessions.

◆ UNREG_SESSION_STORAGE_TYPE_PARAM_DEP

const std::string Engine::FIXPropertiesNames::UNREG_SESSION_STORAGE_TYPE_PARAM_DEP = "UnregisteredSessionStorageType"

Default storage type of the created unregistered sessions.

By default persistent storage type used. Use "transient" value to use transient storage for the sessions.

Deprecated:
Use UnregisteredAcceptor.SessionStorageType instead

◆ V_ADDITIONAL_FIELDS_FILE_NAME_PARAM

const std::string Engine::FIXPropertiesNames::V_ADDITIONAL_FIELDS_FILE_NAME_PARAM = "Validation.AdditionalFieldsFileName"

◆ V_ADDITIONAL_FIELDS_PARAM

const std::string Engine::FIXPropertiesNames::V_ADDITIONAL_FIELDS_PARAM = "Validation.AdditionalFields"

◆ V_ALLOW_EMPTY_FIELD_VALUE_PARAM

const std::string Engine::FIXPropertiesNames::V_ALLOW_EMPTY_FIELD_VALUE_PARAM = "AllowEmptyFieldValue"

When true, raw message may contains tags without values - they will be ignored.

Otherwise exception was fired.

◆ V_ALLOW_ZERO_NUM_IN_GROUP_PARAM

const std::string Engine::FIXPropertiesNames::V_ALLOW_ZERO_NUM_IN_GROUP_PARAM = "AllowZeroNumInGroup"

When true, raw message may contains leading group tag with 0 value - it will be ignored.

Otherwise exception was fired.

◆ V_CHECK_REQUIRED_GROUP_FIELDS_PARAM

const std::string Engine::FIXPropertiesNames::V_CHECK_REQUIRED_GROUP_FIELDS_PARAM = "Validation.CheckRequiredGroupFields"

This parameter controls the validation of required fields in repeating group.

The possible values are "true" and "false". If set to "true" then repeating groups will be checked for presence of required fields. If set to "false" then the responsibility for repeating group validity rests with the counterparty. The recommended setting is "true". This parameter is optional. The default value is "true".

◆ V_IGNORE_UNKNOWN_FIELDS

const std::string Engine::FIXPropertiesNames::V_IGNORE_UNKNOWN_FIELDS = "IgnoreUnknownFields"

If true any field that is unknown to dictionary will be ingnored.

Should be false for development, true for production because if false FA stores all unknown fields in the FIXMessage in the list on the heap. With true it would ignore these fields thus limit storage on heap IMPORTANT NOTE: this value has priority over all other validation settings. for example. Even If MessageMustBeValidated = true, or ProhibitUnknownTags = true, or VerifyTagsValues= true unknown fields are ignored WARNING: Changing this value will impact upon the performance of FIX Engine. In the development should be false and all unknown fields should be listed in the dictionary file. In production should be true.

◆ V_PROHIBIT_DUPLICATED_TAGS

const std::string Engine::FIXPropertiesNames::V_PROHIBIT_DUPLICATED_TAGS = "Validation.ProhibitDuplicatedTags"

This parameter controls duplicate tag handling.

The possible values are "true" and "false". If set to "false" then all duplicated fields will be stored to the message. If set to "true", engine will reject messages with duplicated fields. Default: false

◆ V_PROHIBIT_UNKNOWN_TAGS

const std::string Engine::FIXPropertiesNames::V_PROHIBIT_UNKNOWN_TAGS = "ProhibitUnknownTags"

This parameter controls unknown tag handling.

The possible values are "true" and "false". If set to "false" then all unknown fields will be stored to the message. If set to "true", engine will reject messages with unknown fields. Default: false

◆ V_VALIDATE_MESSAGE_PARAM

const std::string Engine::FIXPropertiesNames::V_VALIDATE_MESSAGE_PARAM = "MessageMustBeValidated"

This parameter controls existence of required tags in application level messages.

The possible values are "true" and "false". If set to "true" then all application level messages are validated. If set to "false" then the responsibility for message validity rests with the counterparty. Please note that session level messages are validated in all cases. The recommended setting is "true".

Warning
Changing this value will impact upon the performance of FIX Engine. In the development should be true. In production should be false.

◆ V_VERIFY_REPERATING_GROUP_BOUNDS

const std::string Engine::FIXPropertiesNames::V_VERIFY_REPERATING_GROUP_BOUNDS = "VerifyReperatingGroupBounds"

This parameter controls repeating group size checking.

If true, engine will reject messages with incorrect repeating group size. Otherwise message will be passed to the application layer. In this case the responsibility for message validity rests with the counterparty. Default: false

◆ V_VERIFY_TAGS_VALUES

const std::string Engine::FIXPropertiesNames::V_VERIFY_TAGS_VALUES = "VerifyTagsValues"

This parameter controls tag values validation.

The possible values are "true" and "false". If set to "true" then all messages will be validated. If set to "false" then the responsibility for message validity rests with the counterparty. Default: false

◆ WORKER_CPU_AFFINITY

const std::string Engine::FIXPropertiesNames::WORKER_CPU_AFFINITY = "WorkerCpuAffinity"

Defines an affinity mask for all worker pool threads.

Default value is 0