FeedConnectionSettings Class Reference

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

Public Member Functions
	FeedConnectionSettings (const SettingGroup *group=nullptr)
	FeedConnectionSettings (const FeedConnectionSettings &other)
	~FeedConnectionSettings ()
Messaging::UInt32	port () const
FeedConnectionSettings &	port (Messaging::UInt32 port)
const std::string &	ip () const
FeedConnectionSettings &	ip (const std::string &address)
const HostListSetting &	hosts () const
HostListSetting &	hosts ()
FeedConnectionSettings &	hosts (const std::string &hosts)
const NifListSetting &	networkInterfaces () const
NifListSetting &	networkInterfaces ()
FeedConnectionSettings &	networkInterfaces (const std::string &interfaces)
const std::string &	id () const
FeedConnectionSettings &	id (const std::string &id)
FeedConnectionSettings &	operator= (const FeedConnectionSettings &other)

Friends
template<class>
class	FeedSettingsBase

Detailed Description

Definition at line 49 of file FeedSettings.h.

Constructor & Destructor Documentation

FeedConnectionSettings() [1/2]

FeedConnectionSettings ( const SettingGroup * group = nullptr )

inline

Initializes as a blank instance.

Definition at line 57 of file FeedSettings.h.

FeedConnectionSettings() [2/2]

FeedConnectionSettings ( const FeedConnectionSettings & other )

inline

Initializes the given instance as a copy of the other one.

Definition at line 67 of file FeedSettings.h.

~FeedConnectionSettings()

~FeedConnectionSettings ( )

inline

Finalizes the instance.

Definition at line 78 of file FeedSettings.h.

Member Function Documentation

hosts() [1/3]

HostListSetting & hosts ( )

inline

Updates list of hosts for the given connection settings.

This component is the optional one and may be used to supply additional information on the connection. For example, if the connection is the multicast one, the given parameter represents a list of remote hosts from which the multicast data is actually transmitted. Also, CME doesn't use IP parameter while defining connections for the TCP Recovery feeds in the connectivity configuration file (config.xml). Instead, this one is used.

Definition at line 139 of file FeedSettings.h.

hosts() [2/3]

const HostListSetting & hosts ( ) const

inline

Indicates host list of the given connection settings.

This component is the optional one and may be used to supply additional information on the connection. For example, if the connection is the multicast one, the given parameter represents a list of remote hosts from which the multicast data is actually transmitted. Also, CME doesn't use IP parameter while defining connections for the TCP Recovery feeds in the connectivity configuration file (config.xml). Instead, this one is used.

Definition at line 125 of file FeedSettings.h.

hosts() [3/3]

FeedConnectionSettings & hosts ( const std::string & hosts )

inline

Updates list of hosts for the given connection settings from a string representing comma or semi-colon separated list of hosts.

This component is the optional one and may be used to supply additional information on the connection. For example, if the connection is the multicast one, the given parameter represents a list of remote hosts from which the multicast data is actually transmitted. Also, CME doesn't use IP parameter while defining connections for the TCP Recovery feeds in the connectivity configuration file (config.xml). Instead, this one is used.

Definition at line 154 of file FeedSettings.h.

id() [1/2]

const std::string & id ( ) const

inline

The unique connection/feed identifier.

Definition at line 195 of file FeedSettings.h.

id() [2/2]

FeedConnectionSettings & id ( const std::string & id )

inline

Updates the connection/feed identifier.

Definition at line 201 of file FeedSettings.h.

ip() [1/2]

const std::string & ip ( ) const

inline

Indicates address component of the given connection settings.

For the multicast type of connection the given parameter indicates a multicast group to join to. For the streamed/TCP connections the given parameter indicates the remote host to connect to.

Definition at line 99 of file FeedSettings.h.

ip() [2/2]

FeedConnectionSettings & ip ( const std::string & address )

inline

Updates address component of the given connection settings.

For the multicast type of connection the given parameter indicates a multicast group to join to. For the streamed/TCP connections the given parameter indicates the remote host to connect to.

Definition at line 109 of file FeedSettings.h.

networkInterfaces() [1/3]

NifListSetting & networkInterfaces ( )

inline

List of network interfaces for the given connection settings.

If the settings refers to a multicast group, the given parameter indicates a list of network interfaces on which the multicast data must be listen to.

Definition at line 176 of file FeedSettings.h.

networkInterfaces() [2/3]

const NifListSetting & networkInterfaces ( ) const

inline

List of network interfaces for the given connection settings.

If the settings refers to a multicast group, the given parameter indicates a list of network interfaces on which the multicast data must be listen to.

Definition at line 166 of file FeedSettings.h.

networkInterfaces() [3/3]

FeedConnectionSettings & networkInterfaces ( const std::string & interfaces )

inline

Specifies one or more network interfaces on which to join the multicast group if the settings define multicast connection. Use semi-colon delimited list to specify multiple interfaces.

Note

On Linux the network interface is specified by its name, on Windows - by IP address.

Definition at line 187 of file FeedSettings.h.

operator=()

FeedConnectionSettings & operator= ( const FeedConnectionSettings & other )

inline

Re-initializes the instance as a copy of the other one.

Definition at line 209 of file FeedSettings.h.

port() [1/2]

Messaging::UInt32 port ( ) const

inline

Port component of the given connection settings.

Definition at line 81 of file FeedSettings.h.

port() [2/2]

FeedConnectionSettings & port ( Messaging::UInt32 port )

inline

Updates port number for the given connection settings.

Definition at line 87 of file FeedSettings.h.

Friends And Related Symbol Documentation

FeedSettingsBase

template<class>

friend class FeedSettingsBase

friend

Definition at line 54 of file FeedSettings.h.