OnixS C++ CME Streamlined Market Data Handler  1.0.0.4
API documentation
FeedEngineSettings Class Reference

#include <FeedEngine.h>

Public Member Functions

 FeedEngineSettings ()
 
 ~FeedEngineSettings ()
 
const ThreadAffinitythreadAffinity () const
 
ThreadAffinitythreadAffinity ()
 
UInt32 threadCount () const
 
void threadCount (UInt32 value)
 
WatchServicewatch () const
 
void watch (WatchService &watch)
 
UInt32 dataWaitTime () const
 
void dataWaitTime (UInt32 value)
 
UInt32 spinBeforeIdleTime () const
 
void spinBeforeIdleTime (UInt32 value)
 
UInt32 socketBufferSize () const
 
void socketBufferSize (UInt32 value)
 

Detailed Description

Definition at line 96 of file FeedEngine.h.

Constructor & Destructor Documentation

FeedEngineSettings ( )
inline

Initializes options with default values.

Definition at line 110 of file FeedEngine.h.

~FeedEngineSettings ( )
inline

Cleans everything up.

Definition at line 123 of file FeedEngine.h.

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 201 of file FeedEngine.h.

void dataWaitTime ( UInt32  value)
inline

Sets dataWaitTime.

See also
dataWaitTime.

Definition at line 208 of file FeedEngine.h.

UInt32 socketBufferSize ( ) const
inline

Defines size of receiving buffer in bytes for sockets.

Note
Default value is 4 MiB.

Definition at line 240 of file FeedEngine.h.

void socketBufferSize ( UInt32  value)
inline

Sets udpSocketBufferSize.

See also
udpSocketBufferSize.

Definition at line 247 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 223 of file FeedEngine.h.

void spinBeforeIdleTime ( UInt32  value)
inline

Sets redundancySpinTime.

See also
redundancySpinTime.

Definition at line 230 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 binded 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 136 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 binded 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 148 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 157 of file FeedEngine.h.

void threadCount ( UInt32  value)
inline

Sets threadsCount.

See also
threadsCount.

Definition at line 164 of file FeedEngine.h.

WatchService& watch ( ) const
inline

Watch service to be used by Feed Engine.

Watch is used by Feed Engine to timestamp packets received from the feeds.

Note
By default, UTC watch service is used.

Definition at line 176 of file FeedEngine.h.

void watch ( WatchService watch)
inline

Watch service to be used by Feed Engine.

If no instance associated, UTC watch is used.

Definition at line 185 of file FeedEngine.h.


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