OnixS C++ CME MDP Conflated UDP Handler 1.1.2
API documentation
Loading...
Searching...
No Matches
FeedSettingsBase< Layout > Class Template Reference

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 SettingGroupgroup () 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() [1/2]

template<typename Layout>
FeedSettingsBase ( const SettingGroup * group,
Layout layout,
UInt32 heartbeat )
inlineprotected

Initializes the instance with the given values and optional grouping.

Definition at line 70 of file FeedSettings.h.

◆ FeedSettingsBase() [2/2]

template<typename Layout>
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 88 of file FeedSettings.h.

◆ ~FeedSettingsBase()

template<typename Layout>
~FeedSettingsBase ( )
inlineprotected

Definition at line 105 of file FeedSettings.h.

Member Function Documentation

◆ assignNoControl()

template<typename Layout>
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 122 of file FeedSettings.h.

◆ feedANetworkInterfaces() [1/2]

template<typename Layout>
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 196 of file FeedSettings.h.

◆ feedANetworkInterfaces() [2/2]

template<typename Layout>
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 205 of file FeedSettings.h.

◆ feedBNetworkInterfaces() [1/2]

template<typename Layout>
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 228 of file FeedSettings.h.

◆ feedBNetworkInterfaces() [2/2]

template<typename Layout>
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 237 of file FeedSettings.h.

◆ group()

template<typename Layout>
const SettingGroup & group ( ) const
inlineprotected

Instance of the group which the given settings belong to.

Definition at line 113 of file FeedSettings.h.

◆ heartbeatInterval() [1/2]

template<typename Layout>
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 166 of file FeedSettings.h.

◆ heartbeatInterval() [2/2]

template<typename Layout>
void heartbeatInterval ( UInt32 interval)
inline

Specifies maximal time interval between two packets.

Definition at line 173 of file FeedSettings.h.

◆ layout() [1/2]

template<typename Layout>
Layout layout ( ) const
inline

Defines feed layout for a feed group.

Definition at line 140 of file FeedSettings.h.

◆ layout() [2/2]

template<typename Layout>
void layout ( Layout value)
inline

Defines feed layout for recovery feed group.

Definition at line 147 of file FeedSettings.h.

◆ FeedSettings

template<typename Layout>
friend class FeedSettings
friend

Definition at line 66 of file FeedSettings.h.