OnixS C++ Cboe CFE Multicast PITCH Market Data Handler  1.10.3
API documentation
Public Member Functions | List of all members
FeedEngineSettings Class Reference

#include <OnixS/CboeCFE/MarketData/Pitch/FeedEngine.h>

Public Member Functions

 FeedEngineSettings ()
 
const ThreadAffinity & threadAffinity () const
 
ThreadAffinity & threadAffinity ()
 
UInt32 threadCount () const
 
void threadCount (UInt32 value)
 
UInt32 dataWaitTime () const
 
void dataWaitTime (UInt32 value)
 
UInt32 spinBeforeIdleTime () const
 
void spinBeforeIdleTime (UInt32 value)
 
UInt32 socketBufferSize () const
 
void socketBufferSize (UInt32 value)
 
std::string toString () const
 

Detailed Description

Definition at line 37 of file FeedEngine.h.

Constructor & Destructor Documentation

FeedEngineSettings ( )

Initializes options with default values.

Member Function Documentation

UInt32 dataWaitTime ( ) const
inline

Defines amount of time Feed Engine spends on socket waiting for I/O while running master processing loop.

Time is measured in milliseconds.

Note
Default value is '10'.
Warning
Given parameter significantly affects Handler's responsiveness and load onto CPU!

Definition at line 99 of file FeedEngine.h.

void dataWaitTime ( UInt32  value)
inline

Sets dataWaitTime.

See also
dataWaitTime.

Definition at line 105 of file FeedEngine.h.

UInt32 socketBufferSize ( ) const
inline

Defines size of receiving buffer in bytes for sockets.

Note
Default value is 8 MiB.

Definition at line 132 of file FeedEngine.h.

void socketBufferSize ( UInt32  value)
inline

Sets udpSocketBufferSize.

See also
udpSocketBufferSize.

Definition at line 138 of file FeedEngine.h.

UInt32 spinBeforeIdleTime ( ) const
inline

Defines amount of time Feed Engine keeps cycling before going to sleep when no useful activity can be done.

Time is measured in milliseconds.

Note
Default value is '1'.
Warning
Given parameter has direct influence onto CPU load!

Definition at line 118 of file FeedEngine.h.

void spinBeforeIdleTime ( UInt32  value)
inline

Sets redundancySpinTime.

See also
redundancySpinTime.

Definition at line 124 of file FeedEngine.h.

const ThreadAffinity& threadAffinity ( ) const
inline

Defines set of CPUs allowed for each working thread to be executed on while processing market data by Handlers bound to Feed Engine instance which is configured by given settings.

Note
By default set is empty thus allowing threads to be executed on any CPU available in the system.

Definition at line 59 of file FeedEngine.h.

ThreadAffinity& threadAffinity ( )
inline

Defines set of CPUs allowed for each working thread to be executed on while processing market data by Handlers bound to Feed Engine instance which is configured by given settings.

Note
By default set is empty thus allowing threads to be executed on any CPU available in the system.

Definition at line 71 of file FeedEngine.h.

UInt32 threadCount ( ) const
inline

Number of working threads to be used by feed engine.

Note
Default value is '1'.

Definition at line 79 of file FeedEngine.h.

void threadCount ( UInt32  value)
inline

Sets threadsCount.

See also
threadsCount.

Definition at line 85 of file FeedEngine.h.

std::string toString ( ) const

Returns the string representation.

The documentation for this class was generated from the following file: