OnixS C++ CME MDP Premium Market Data Handler  5.8.9
API Documentation
Public Member Functions | Protected Member Functions | Friends | List of all members
FeedSettingsBase< Layout > Class Template Reference

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

Public Member Functions

Layout layout () const
 
FeedSettingsBase & layout (Layout value)
 
UInt32 heartbeatInterval () const
 
FeedSettingsBase & heartbeatInterval (UInt32 interval)
 
FeedConnectionSettings & A ()
 
const FeedConnectionSettings & A () const
 
FeedConnectionSettings & B ()
 
const FeedConnectionSettings & B () const
 
FeedSettingsBase & feedANetworkInterfaces (const std::string &interfaces)
 
FeedSettingsBase & feedBNetworkInterfaces (const std::string &interfaces)
 

Protected Member Functions

 FeedSettingsBase (const SettingGroup *group, Layout layout, UInt32 heartbeat)
 
 FeedSettingsBase (const FeedSettingsBase &other)
 
 ~FeedSettingsBase ()
 
const SettingGroup & group () const
 
void assignNoControl (const FeedSettingsBase &other)
 

Friends

class FeedSettings
 

Detailed Description

template<typename Layout>
class OnixS::CME::MDH::FeedSettingsBase< Layout >

Definition at line 251 of file FeedSettings.h.

Constructor & Destructor Documentation

FeedSettingsBase ( const SettingGroup *  group,
Layout  layout,
UInt32  heartbeat 
)
inlineprotected

Initializes the instance with the given values and optional grouping.

Definition at line 352 of file FeedSettings.h.

FeedSettingsBase ( const FeedSettingsBase< Layout > &  other)
inlineprotected

Initializes the instance as a copy of the other one.

Attributes controlling value assignment aren't cloned and thus only settings are copied.

Definition at line 367 of file FeedSettings.h.

~FeedSettingsBase ( )
inlineprotected

Definition at line 377 of file FeedSettings.h.

Member Function Documentation

FeedConnectionSettings& A ( )
inline

Connection attributes for the primary (A) feed.

Definition at line 288 of file FeedSettings.h.

const FeedConnectionSettings& A ( ) const
inline

Connection attributes for the primary (A) feed.

Definition at line 294 of file FeedSettings.h.

void assignNoControl ( const FeedSettingsBase< Layout > &  other)
inlineprotected

Re-initializes the instance as a copy of the other one without involving assignment control services.

Definition at line 389 of file FeedSettings.h.

FeedConnectionSettings& B ( )
inline

Connection attributes for the secondary (B) feed.

Definition at line 300 of file FeedSettings.h.

const FeedConnectionSettings& B ( ) const
inline

Connection attributes for the secondary (B) feed.

Definition at line 306 of file FeedSettings.h.

FeedSettingsBase& feedANetworkInterfaces ( const std::string &  interfaces)
inline

Specifies one or more network interfaces to use for primary (A) feeds while joining the multicast group.

Use semi-colon to delimit multiple interfaces.

Note
On Linux the network interface is specified by its name, on Windows - by IP address.
Warning
The given member is deprecated. Use feed connection settings instead.

Definition at line 322 of file FeedSettings.h.

FeedSettingsBase& feedBNetworkInterfaces ( const std::string &  interfaces)
inline

Specifies one or more network interfaces to use for secondary (B) feeds while joining the multicast group.

Use semi-colon to delimit multiple interfaces.

Note
On Linux the network interface is specified by its name, on Windows - by IP address.
Warning
The given member is deprecated. Use feed connection settings instead.

Definition at line 338 of file FeedSettings.h.

const SettingGroup& group ( ) const
inlineprotected

Instance of the group which the given settings belong to.

Definition at line 381 of file FeedSettings.h.

UInt32 heartbeatInterval ( ) const
inline

Specifies maximal time interval between two network packets.

If no data is received during specified time frame, corresponding event is raised and further behavior is defined by feed layout.

Interval is measured in seconds.

Definition at line 274 of file FeedSettings.h.

FeedSettingsBase& heartbeatInterval ( UInt32  interval)
inline

Specifies maximal time interval between two packets.

Definition at line 280 of file FeedSettings.h.

Layout layout ( ) const
inline

Defines feed layout for a feed group.

Definition at line 255 of file FeedSettings.h.

FeedSettingsBase& layout ( Layout  value)
inline

Defines feed layout for recovery feed group.

Definition at line 261 of file FeedSettings.h.

Friends And Related Function Documentation

friend class FeedSettings
friend

Definition at line 348 of file FeedSettings.h.

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