OnixS C++ CME MDP Premium Market Data Handler  5.8.9
API Documentation
Public Member Functions | List of all members
SolarflareFeedEngineSettings Class Reference

#include <OnixS/CME/MDH/SolarflareFeedEngine.h>

Public Member Functions

 SolarflareFeedEngineSettings ()
 
 ~SolarflareFeedEngineSettings ()
 
SolarflareFeedEngineOperatingMode::Enum mode () const
 
void mode (SolarflareFeedEngineOperatingMode::Enum mode)
 
UInt32 receiveRingSize () const
 
void receiveRingSize (UInt32 ringSize)
 
UInt32 cacheSize () const
 
void cacheSize (UInt32 cacheSize)
 
UInt32 socketBufferSize () const
 
void socketBufferSize (UInt32 bufferSize)
 
WatchService & watch () const
 
void watch (WatchService &watch)
 

Detailed Description

Definition at line 80 of file SolarflareFeedEngine.h.

Constructor & Destructor Documentation

SolarflareFeedEngineSettings ( )
inline

Initializes the given instance of the network settings with the default values.

Definition at line 85 of file SolarflareFeedEngine.h.

~SolarflareFeedEngineSettings ( )
inline

Cleans everything up.

Definition at line 95 of file SolarflareFeedEngine.h.

Member Function Documentation

UInt32 cacheSize ( ) const
inline

Size of a pool of buffers used to receive and manipulate incoming data.

The Feed Engine puts incoming packets into buffers and keeps buffers busy until received data is processed by handlers. In case of rapid transmission, buffers may be allocated quicker than they are processed and released back to pool. Therefore, the pool must be capacious enough to avoid data losses.

Definition at line 144 of file SolarflareFeedEngine.h.

void cacheSize ( UInt32  cacheSize)
inline

Size of pool of buffers used to receive and manipulate incoming data.

Definition at line 151 of file SolarflareFeedEngine.h.

SolarflareFeedEngineOperatingMode::Enum mode ( ) const
inline

The operational mode for the Feed Engine.

Definition at line 98 of file SolarflareFeedEngine.h.

void mode ( SolarflareFeedEngineOperatingMode::Enum  mode)
inline

Defines the operational mode for the Feed Engine.

Definition at line 104 of file SolarflareFeedEngine.h.

UInt32 receiveRingSize ( ) const
inline

Number of buffers in a virtual interface receive ring.

Single buffer is used for a single network packet. Thus the receive ring must be capacious enough to place incoming packets during market data bursts.

By default, the parameter is set to '-1' which means receive ring will be constructed of the default capacity.

Definition at line 117 of file SolarflareFeedEngine.h.

void receiveRingSize ( UInt32  ringSize)
inline

Number of buffers in a virtual interface receive ring.

Single buffer is used for a single network packet. Thus the receive ring must be capacious enough to place incoming packets during market data bursts.

By default, the parameter is set to '-1' which means receive ring will be constructed of the default capacity.

Definition at line 130 of file SolarflareFeedEngine.h.

UInt32 socketBufferSize ( ) const
inline

Socket buffer size.

When the Solarflare Feed Engine operates in mixed mode, ordinary sockets are used to receive multicast data on non-Solarflare network interfaces. The given parameter defines size of a buffer used by socket to store incoming data before it's retrieved by the Solarflare Feed Engine.

Definition at line 163 of file SolarflareFeedEngine.h.

void socketBufferSize ( UInt32  bufferSize)
inline

Specifies socket buffer size.

When the Solarflare Feed Engine operates in mixed mode, ordinary sockets are used to receive multicast data on non-Solarflare network interfaces. The given parameter defines size of a buffer used by socket to store incoming data before it's retrieved by the Solarflare Feed Engine.

Definition at line 175 of file SolarflareFeedEngine.h.

WatchService& watch ( ) const
inline

Watch service to be used by the Solarlfare Feed Engine.

Watch is used by the Solarlfare Feed Engine to assign time stamps to incoming packets (received from feeds).

Note
By default, the TC watch service is used.

Definition at line 186 of file SolarflareFeedEngine.h.

void watch ( WatchService &  watch)
inline

Watch service to be used by Feed Engine.

If no instance is associated, the UTC watch is used.

Definition at line 194 of file SolarflareFeedEngine.h.

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