SocketFeedEngineSettings Class Reference

#include <OnixS/CME/ConflatedUDP/SocketFeedEngine.h>

Public Member Functions
	SocketFeedEngineSettings ()
	~SocketFeedEngineSettings ()
PacketSize	packetMaxSize () const
void	packetMaxSize (PacketSize value)
WatchService &	watch () const
void	watch (WatchService &watch)
UInt32	socketBufferSize () const
void	socketBufferSize (UInt32 value)
UInt32	dataWaitTime () const
void	dataWaitTime (UInt32 value)

Detailed Description

Represents a collection of settings affecting the behavior of the multi-threaded feed engine while working with network-related services.

Definition at line 32 of file SocketFeedEngine.h.

Constructor & Destructor Documentation

SocketFeedEngineSettings ( )

inline

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

Definition at line 44 of file SocketFeedEngine.h.

~SocketFeedEngineSettings ( )

inline

Cleans everything up.

Definition at line 53 of file SocketFeedEngine.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

The given parameter significantly affects responsiveness of the Handler and load onto CPU.

Definition at line 121 of file SocketFeedEngine.h.

void dataWaitTime ( UInt32  value )

inline

Sets dataWaitTime.

See also

dataWaitTime.

Definition at line 128 of file SocketFeedEngine.h.

PacketSize packetMaxSize ( ) const

inline

Max size for network packet transmitted by MDP.

Note

Default value is '1420'.

Definition at line 60 of file SocketFeedEngine.h.

void packetMaxSize ( PacketSize  value )

inline

Max size for network packet transmitted by MDP.

Definition at line 67 of file SocketFeedEngine.h.

UInt32 socketBufferSize ( ) const

inline

Defines size of receiving buffer in bytes for sockets.

Note

Default value is 8 MiB.

Definition at line 98 of file SocketFeedEngine.h.

void socketBufferSize ( UInt32  value )

inline

Sets socketBufferSize.

See also

socketBufferSize.

Definition at line 105 of file SocketFeedEngine.h.

WatchService& watch ( ) const

inline

Watch service to be used by Feed Engine.

Watch is used by Feed Engine to assign time points to packets received from the feeds.

Note

By default, UTC watch service is used.

Definition at line 79 of file SocketFeedEngine.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 88 of file SocketFeedEngine.h.

---

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

• include/OnixS/CME/ConflatedUDP/SocketFeedEngine.h