SolarflareFeedEngineSettings Class Reference

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

Public Member Functions
	SolarflareFeedEngineSettings ()
	~SolarflareFeedEngineSettings ()=default
SolarflareFeedEngineOperatingMode::Enum	mode () const
void	mode (SolarflareFeedEngineOperatingMode::Enum mode)
SolarflareFeedEngineMemoryPolicy::Enum	memoryPolicy () const
void	memoryPolicy (SolarflareFeedEngineMemoryPolicy::Enum policy)
Messaging::UInt32	receiveRingSize () const
void	receiveRingSize (Messaging::UInt32 ringSize)
Messaging::UInt32	cacheSize () const
void	cacheSize (Messaging::UInt32 cacheSize)
Messaging::UInt32	socketBufferSize () const
void	socketBufferSize (Messaging::UInt32 bufferSize)
WatchService &	watch () const
void	watch (WatchService &watch)
Public Member Functions inherited from NetFeedEngineSettings
	NetFeedEngineSettings ()
Logger *	logger () const
Logger &	loggerOrDefault () const
NetFeedEngineSettings &	logger (Logger *logger)

Detailed Description

Represents a collection of settings affecting the behavior of the Feed Engine while working with virtual interfaces.

Definition at line 139 of file SolarflareFeedEngine.h.

Constructor & Destructor Documentation

SolarflareFeedEngineSettings()

SolarflareFeedEngineSettings ( )

inline

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

Definition at line 144 of file SolarflareFeedEngine.h.

~SolarflareFeedEngineSettings()

~SolarflareFeedEngineSettings ( )

default

Cleans everything up.

Member Function Documentation

cacheSize() [1/2]

Messaging::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 218 of file SolarflareFeedEngine.h.

cacheSize() [2/2]

void cacheSize ( Messaging::UInt32 cacheSize )

inline

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

Definition at line 225 of file SolarflareFeedEngine.h.

memoryPolicy() [1/2]

SolarflareFeedEngineMemoryPolicy::Enum memoryPolicy ( ) const

inline

Returns the memory-allocation policy used for Solarflare receive buffers.

Returns

Configured memory-allocation policy.

Definition at line 171 of file SolarflareFeedEngine.h.

memoryPolicy() [2/2]

void memoryPolicy ( SolarflareFeedEngineMemoryPolicy::Enum policy )

inline

Sets the memory-allocation policy used for Solarflare receive buffers.

Parameters

policy

Memory-allocation policy to use.

Definition at line 178 of file SolarflareFeedEngine.h.

mode() [1/2]

SolarflareFeedEngineOperatingMode::Enum mode ( ) const

inline

The operational mode for the Feed Engine.

Definition at line 158 of file SolarflareFeedEngine.h.

mode() [2/2]

void mode ( SolarflareFeedEngineOperatingMode::Enum mode )

inline

Defines the operational mode for the Feed Engine.

Definition at line 164 of file SolarflareFeedEngine.h.

receiveRingSize() [1/2]

Messaging::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 191 of file SolarflareFeedEngine.h.

receiveRingSize() [2/2]

void receiveRingSize ( Messaging::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 204 of file SolarflareFeedEngine.h.

socketBufferSize() [1/2]

Messaging::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 237 of file SolarflareFeedEngine.h.

socketBufferSize() [2/2]

void socketBufferSize ( Messaging::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 249 of file SolarflareFeedEngine.h.

watch() [1/2]

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 260 of file SolarflareFeedEngine.h.

watch() [2/2]

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 268 of file SolarflareFeedEngine.h.