B2BITS FIX Antenna C++  2.27.1
Public Member Functions | Public Attributes | List of all members
Bats::RuntimeParameters Struct Reference

Bats::Application runtime parameters. More...

#include <B2BITS_BatsApplication.h>

+ Collaboration diagram for Bats::RuntimeParameters:

Public Member Functions

 RuntimeParameters ()
 

Public Attributes

System::u16 incrementalThreads
 Number of incremental threads. More...
 
System::u16 linkDownTimeoutS
 Number of seconds before ServiceListener::Notification::LinkDown notification is generated. More...
 
std::string logDirectory
 Path of the directory where the log files will be created. More...
 
bool logIncomingBinaryMessages
 Log incoming messages to binary files. More...
 
bool logIncomingMessages
 Log incoming messages as text. More...
 
System::u16 minSharesValue
 Minimum acceptable number of shares. More...
 
IncrementReaderType::Type readerType
 Type of increments reader. More...
 
SequenceParams sequenceParams
 Sequence parameters. More...
 
TCPParams tcpParams
 TCP parameters. More...
 
UDPParams udpParams
 UDP parameters. More...
 
bool useNaturalRefresh
 Use 'natural refresh' instead of GRP/Spin. More...
 
bool useWorkersForIncrements
 Use worker pool for increments. More...
 
System::u16 workerThreads
 Number of worker threads. More...
 

Detailed Description

Bats::Application runtime parameters.

Parameters can be global, or specified at channel or unit levels See bats_mda_configuration for details

Constructor & Destructor Documentation

◆ RuntimeParameters()

Bats::RuntimeParameters::RuntimeParameters ( )
inline

Member Data Documentation

◆ incrementalThreads

System::u16 Bats::RuntimeParameters::incrementalThreads

Number of incremental threads.

If set to 0 - no threads will be created.
Default value: 2

◆ linkDownTimeoutS

System::u16 Bats::RuntimeParameters::linkDownTimeoutS

Number of seconds before ServiceListener::Notification::LinkDown notification is generated.

If this property is set to 0 - LinkXXX notifications are not generated.
Default value = 0

◆ logDirectory

std::string Bats::RuntimeParameters::logDirectory

Path of the directory where the log files will be created.

Default value: "." - current directory

◆ logIncomingBinaryMessages

bool Bats::RuntimeParameters::logIncomingBinaryMessages

Log incoming messages to binary files.

All incoming UDP and TCP messages will logged to the files in binary format.
Default value: false

Note
Setting this value to true, will impact upon the performance.

◆ logIncomingMessages

bool Bats::RuntimeParameters::logIncomingMessages

Log incoming messages as text.

All incoming UDP messages will logged as text to the log file.
Default value: false

Note
Setting this value to true, will impact upon the performance.

◆ minSharesValue

System::u16 Bats::RuntimeParameters::minSharesValue

Minimum acceptable number of shares.

Orders with quantity less than this value will be ignored.
Default value: 1 - all orders are accepted

◆ readerType

IncrementReaderType::Type Bats::RuntimeParameters::readerType

Type of increments reader.

Default value: IncrementReaderType::ThreadPool

◆ sequenceParams

SequenceParams Bats::RuntimeParameters::sequenceParams

Sequence parameters.

◆ tcpParams

TCPParams Bats::RuntimeParameters::tcpParams

TCP parameters.

◆ udpParams

UDPParams Bats::RuntimeParameters::udpParams

UDP parameters.

◆ useNaturalRefresh

bool Bats::RuntimeParameters::useNaturalRefresh

Use 'natural refresh' instead of GRP/Spin.

Setting this option to true allows to recover from gaps without using GRP or Spin server. Instead of initiating replay or recovery, service generates onReset event with ResetReason::rrNaturalRefresh, clears cache, all books and process current packet as properly ordered.
Default value: false

Note
Please note that in case of 'natural refresh' state of book is not restored immediately, and there is now way to find out when the book contains consistent data, but due to short lifetime of BATS orders, 'natural refresh' could be useful. Set this property to true at your own risk

◆ useWorkersForIncrements

bool Bats::RuntimeParameters::useWorkersForIncrements

Use worker pool for increments.

When this parameter is set to true, thread pool of worker threads is used for reading UDP multicast messages. Incremental threads are not created. RuntimeParameters::readerType parameter is ignored.
Default value: false

◆ workerThreads

System::u16 Bats::RuntimeParameters::workerThreads

Number of worker threads.

If set to 0 - no threads will be created.
Default value: 2