Classes | |
| struct | Default |
| struct | Key |
Public Types | |
| typedef std::vector< std::string > | LicenseStores |
Static Public Attributes | |
| static const int | UseOsDefaultSocketBufferSize = -1 |
Definition at line 37 of file SessionSettings.h.
| typedef std::vector<std::string> LicenseStores |
Folders that contain license file(s).
Definition at line 150 of file SessionSettings.h.
| SessionSettings | ( | ) |
| SessionSettings & addLicenseStore | ( | const std::string & | value | ) |
Adds the path to the folder that contains license file(s).
|
inlinenoexcept |
By default, the size is unlimited.
Definition at line 248 of file SessionSettings.h.
| SessionSettings & asyncFileBasedStorageQueueMaxSize | ( | unsigned | value | ) |
Sets the maximum size of the asynchronous session storage queue.
|
inlinenoexcept |
By default, the affinity is not set.
Definition at line 261 of file SessionSettings.h.
| SessionSettings & asyncFileBasedStorageThreadAffinity | ( | const CpuIndexes & | cpuIndexes | ) |
Specifies the CPU index(es) for affinity of the asynchronous session storage threads.
|
inlinenoexcept |
The default value is empty.
Definition at line 60 of file SessionSettings.h.
| SessionSettings & clientId | ( | Messaging::Int32 | value | ) |
Sets the firm id that was assigned by the exchange.
|
inlinenoexcept |
The default value is false.
Definition at line 509 of file SessionSettings.h.
| SessionSettings & enableRxTimestamp | ( | bool | value | ) |
Sets the value of the option to enable received data timestamp.
|
inlinenoexcept |
The default value is Default::FileBasedStorageSegmentSize.
Definition at line 235 of file SessionSettings.h.
| SessionSettings & fileBasedStorageSegmentSize | ( | Messaging::UInt64 | value | ) |
Sets the segment size for file-based session storage.
|
inlinenoexcept |
The default value is Default::IgnoreFileBasedStorageIntegrityErrors.
Definition at line 277 of file SessionSettings.h.
| SessionSettings & ignoreFileBasedStorageIntegrityErrors | ( | bool | ) |
Sets the file-based storage integrity errors checking mode.
|
inlinenoexcept |
The default value is Default::KeepAliveInterval.
Definition at line 439 of file SessionSettings.h.
| SessionSettings & keepAliveInterval | ( | unsigned short | seconds | ) |
Sets the longest time in seconds the client system can remain silent before sending a message.
|
inlinenoexcept |
The default value is Default::LicenseAlertingDaysBeforeExpiration.
Definition at line 165 of file SessionSettings.h.
|
inline |
Sets the number of days to alert before the license expiration.
If the amount of remaining license days is less or equal to this number, then the warning is reported to the Handler's log.
The verification is performed during the Session::connect call.
Definition at line 177 of file SessionSettings.h.
| SessionSettings & licenseStore | ( | const std::string & | value | ) |
Sets the path to the folder that contains license file(s).
|
inlinenoexcept |
The default value is '.'.
Definition at line 156 of file SessionSettings.h.
| SessionSettings & load | ( | const std::string & | configFile | ) |
Loads the settings from the given configuration file.
|
inlinenoexcept |
The default value is empty.
Definition at line 187 of file SessionSettings.h.
| SessionSettings & localNetworkInterface | ( | const std::string & | value | ) |
Specifies the local interface from which the Handler connects to the counterparty.
Each local interface specification could specify the local IP address and port. For instance, localhost and 192.168.0.1:4501 are valid values.
|
inlinenoexcept |
Definition at line 474 of file SessionSettings.h.
| SessionSettings & localPortRange | ( | PortRange | range | ) |
Sets the range of the local ports to be used.
|
inlinenoexcept |
The default value is Default::LocalTimeUsage.
Definition at line 220 of file SessionSettings.h.
| SessionSettings & localTimeUsage | ( | bool | ) |
Specifies the usage of the local time in Handler events and log files.
If it is true, then the local time is used; otherwise - UTC.
|
inlinenoexcept |
The default value is Default::LogBeforeSending.
Definition at line 290 of file SessionSettings.h.
| SessionSettings & logBeforeSending | ( | bool | before | ) |
Controls the order of logging and sending outbound messages.
| before | if 'true' then outbound messages are logged before sending. |
|
inlinenoexcept |
The default value is LogLevel::Info.
Definition at line 549 of file SessionSettings.h.
| SessionSettings & loggerOptions | ( | LogSettings::Enum | value | ) |
Sets the the logger options.
|
inlinenoexcept |
The default value is LogLevel::Info.
Definition at line 536 of file SessionSettings.h.
| SessionSettings & logLevel | ( | LogLevel::Enum | value | ) |
Sets the severity level of log messages.
|
inlinenoexcept |
The default value is Default::MessageGrouping.
Definition at line 129 of file SessionSettings.h.
| SessionSettings & messageGrouping | ( | unsigned | value | ) |
Sets the message grouping mode.
|
inlinenoexcept |
Definition at line 487 of file SessionSettings.h.
| SessionSettings & messagingSchemaVersion | ( | Messaging::SchemaVersion | schema | ) |
Specifies the version of the message schema.
Allowed range is between Messaging::SchemaTraits::MinimalVersion - Messaging::SchemaTraits::Version. The default value is Messaging::SchemaTraits::Version.
|
inlinenoexcept |
The default value is empty.
Definition at line 73 of file SessionSettings.h.
| SessionSettings & rawData | ( | const std::string & | value | ) |
Sets the secret key that was assigned by the exchange.
|
inlinenoexcept |
The default value is Default::ReasonableTransmissionTime.
Definition at line 351 of file SessionSettings.h.
| SessionSettings & reasonableTransmissionTime | ( | unsigned | percentage | ) |
Sets the reasonable transmission time - as the percentage from the KeepAliveInterval value.
|
inlinenoexcept |
The default value is Default::ReceiveSpinningTimeout.
Definition at line 99 of file SessionSettings.h.
| SessionSettings & receiveSpinningTimeout | ( | unsigned | usecTimeout | ) |
Sets the receive spinning timeout (microseconds).
|
inlinenoexcept |
The default value is Default::ReconnectAttempts.
Definition at line 305 of file SessionSettings.h.
| SessionSettings & reconnectAttempts | ( | unsigned | reconnectAttempts | ) |
Sets the maximum number of tries to restore the telecommunications link.
|
inlinenoexcept |
The default value is Default::ReconnectInterval.
Definition at line 318 of file SessionSettings.h.
| SessionSettings & reconnectInterval | ( | unsigned | value | ) |
Sets the time interval between retries to restore the telecommunications link (seconds).
Should not be zero.
|
inlinenoexcept |
The default value is Default::ReportNewMessagesWhileWaitingForMissedMessages.
Definition at line 457 of file SessionSettings.h.
| SessionSettings & reportNewMessagesWhileWaitingForMissedMessages | ( | bool | report | ) |
Sets the option to report new messages even when the message gap is detected, and the reply on the Retransmit Request message is expected.
| SessionSettings & resetToDefaults | ( | ) |
Resets the settings to the default values.
|
inlinenoexcept |
The default value is Default::SendSpinningTimeout.
Definition at line 112 of file SessionSettings.h.
| SessionSettings & sendSpinningTimeout | ( | unsigned | usecTimeout | ) |
Sets the send spinning timeout (microseconds).
|
inlinenoexcept |
The default value is Default::SocketReceiveBufferSize.
Definition at line 335 of file SessionSettings.h.
| SessionSettings & socketReceiveBufferSize | ( | int | bufferSize | ) |
Sets the socket receive buffer size.
| bufferSize | the size of the socket receive buffer size. If SessionSettings::UseOsDefaultSocketBufferSize then the default operating system value is used. |
|
inlinenoexcept |
The default value is Default::SocketSendBufferSize.
Definition at line 364 of file SessionSettings.h.
| SessionSettings & socketSendBufferSize | ( | int | bufferSize | ) |
Sets the size of the socket send buffer size.
| bufferSize | the size of the socket send buffer size. If SessionSettings::UseOsDefaultSocketBufferSize then the default operating system value is used. |
|
inlinenoexcept |
Inbound and outbound messages, session's state data and the log file are stored in this directory.
The default value is MsgStorage.
Definition at line 205 of file SessionSettings.h.
| SessionSettings & storageDirectory | ( | const std::string & | value | ) |
Sets the Session Storage directory.
Inbound and outbound messages, session's state data and the log file are stored in this directory.
|
inlinenoexcept |
The default value is Default::TcpNoDelayOption.
Definition at line 413 of file SessionSettings.h.
| SessionSettings & tcpNoDelayOption | ( | bool | value | ) |
Sets the value of the option to improve latency at the expense of message throughput (the TCP_NODELAY socket option).
|
inlinenoexcept |
The default value is Default::ThreadingModelValue.
Definition at line 86 of file SessionSettings.h.
| SessionSettings & threadingModel | ( | ThreadingModel::Enum | value | ) |
Sets the threading model.
|
inlinenoexcept |
Definition at line 378 of file SessionSettings.h.
| SessionSettings & threadPoolAffinity | ( | const CpuIndexes & | cpuIndexes | ) |
Sets the thread pool affinity.
|
inlinenoexcept |
Definition at line 400 of file SessionSettings.h.
| SessionSettings & threadPoolPolicy | ( | int | policy | ) |
Sets the thread pool policy.
|
inlinenoexcept |
Definition at line 389 of file SessionSettings.h.
| SessionSettings & threadPoolPriority | ( | int | priority | ) |
Sets the thread pool priority.
|
inlinenoexcept |
The default value is Default::ThreadPoolSize.
Definition at line 426 of file SessionSettings.h.
| SessionSettings & threadPoolSize | ( | unsigned | numberOfThreads | ) |
Sets the size of the shared thread pool.
| std::string toString | ( | ) | const |
|
inlinenoexcept |
The default value is empty.
Definition at line 47 of file SessionSettings.h.
| SessionSettings & userId | ( | const std::string & | value | ) |
Sets the session id that was assigned by the exchange.
|
inlinenoexcept |
The default value is false.
Definition at line 496 of file SessionSettings.h.
| SessionSettings & useSpinLock | ( | bool | value | ) |
Sets the value of the option to the option to use spin lock.
|
inlinenoexcept |
The default value is false.
Definition at line 523 of file SessionSettings.h.
| SessionSettings & useTLS | ( | bool | value | ) |
Sets the value of the option to enable TLS.
|
static |
Specifies the usage of the operating system default socket buffer size.
Definition at line 329 of file SessionSettings.h.