OnixS C++ CME MDP Conflated UDP Handler  1.1.2
API documentation
Public Member Functions | Protected Member Functions | Friends | List of all members
FeedSettingsBase< Layout > Class Template Reference

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

Public Member Functions

Layout layout () const
 
void layout (Layout value)
 
UInt32 heartbeatInterval () const
 
void heartbeatInterval (UInt32 interval)
 
const std::string & feedANetworkInterfaces () const
 
void feedANetworkInterfaces (const std::string &interfaces)
 
const std::string & feedBNetworkInterfaces () const
 
void 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::ConflatedUDP::FeedSettingsBase< Layout >

Collection of parameters which are common for all types of feeds.

Definition at line 44 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 66 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 84 of file FeedSettings.h.

~FeedSettingsBase ( )
inlineprotected

Definition at line 101 of file FeedSettings.h.

Member Function Documentation

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 118 of file FeedSettings.h.

const std::string& feedANetworkInterfaces ( ) const
inline

Specifies one or more network interfaces to use for "A" feeds while joining the multicast group; use semi-colon delimited list if more than one.

Note
On Linux the network interface is specified by its name, on Windows - by IP address.
If the value is empty or absent then the Settings::networkInterface value is used.

Definition at line 192 of file FeedSettings.h.

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

Specifies one or more network interfaces to use for "A" feeds while joining the multicast group; use semi-colon delimited list if more than one.

Definition at line 201 of file FeedSettings.h.

const std::string& feedBNetworkInterfaces ( ) const
inline

Specifies one or more network interfaces to use for "B" feeds while joining the multicast group; use semi-colon delimited list if more than one.

Note
On Linux the network interface is specified by its name, on Windows - by IP address.
If the value is empty or absent then the Settings::networkInterface value is used.

Definition at line 224 of file FeedSettings.h.

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

Specifies one or more network interfaces to use for "B" feeds while joining the multicast group; use semi-colon delimited list if more than one.

Definition at line 233 of file FeedSettings.h.

const SettingGroup& group ( ) const
inlineprotected

Instance of the group which the given settings belong to.

Definition at line 109 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 162 of file FeedSettings.h.

void heartbeatInterval ( UInt32  interval)
inline

Specifies maximal time interval between two packets.

Definition at line 169 of file FeedSettings.h.

Layout layout ( ) const
inline

Defines feed layout for a feed group.

Definition at line 136 of file FeedSettings.h.

void layout ( Layout  value)
inline

Defines feed layout for recovery feed group.

Definition at line 143 of file FeedSettings.h.

Friends And Related Function Documentation

friend class FeedSettings
friend

Definition at line 62 of file FeedSettings.h.

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