OnixS C++ CME Market Data Handler  5.7.0
API documentation
Public Member Functions | Friends | List of all members
FeedSettings Class Reference

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

Public Member Functions

 FeedSettings (SettingChangeController *controller=NULL)
 
 FeedSettings (const FeedSettings &other)
 
const std::string & connectivityConfigurationFile () const
 
DataCenter::Enum dataCenter () const
 
FeedSettings & connectivityConfigurationFile (const std::string &configurationFile, DataCenter::Enum dataCenter=DataCenter::Primary)
 
FeedSettings & feedANetworkInterfaces (const std::string &interfaces)
 
FeedSettings & feedBNetworkInterfaces (const std::string &interfaces)
 
PacketSize packetMaxSize () const
 
FeedSettings & packetMaxSize (PacketSize value)
 
const RealtimeFeedSettings & incrementalFeeds () const
 
RealtimeFeedSettings & incrementalFeeds ()
 
const MulticastRecoveryFeedSettings & instrumentFeeds () const
 
MulticastRecoveryFeedSettings & instrumentFeeds ()
 
const MulticastRecoveryFeedSettings & snapshotFeeds () const
 
MulticastRecoveryFeedSettings & snapshotFeeds ()
 
const MulticastRecoveryFeedSettings & mboSnapshotFeeds () const
 
MulticastRecoveryFeedSettings & mboSnapshotFeeds ()
 
const TcpRecoveryFeedSettings & historicalFeeds () const
 
TcpRecoveryFeedSettings & historicalFeeds ()
 
NetFeedEngine * engine () const
 
FeedSettings & engine (NetFeedEngine *engine)
 
FeedSettings & operator= (const FeedSettings &other)
 
- Public Member Functions inherited from SettingGroup
 SettingGroup (SettingChangeController *controller=NULL)
 
 ~SettingGroup ()
 
template<class Assignee , class Value >
void controlAssignment (const Char *description, Assignee &assignee, Value value) const
 
template<class Changeable >
void controlChange (const Char *description, void(Changeable::*change)(), Changeable &changeable) const
 
template<class Change , class Changeable , class Arg >
void controlChange (const Char *description, Change change, Changeable &changeable, const Arg &arg) const
 
template<class Change , class Changeable , class Arg1 , class Arg2 >
void controlChange (const Char *description, Change change, Changeable &changeable, const Arg1 &arg1, const Arg2 &arg2) const
 

Friends

class HandlerSettings
 

Additional Inherited Members

- Static Public Member Functions inherited from SettingGroup
static ONIXS_CMEMDH_EXPORTED const SettingGroup & null ()
 

Detailed Description

The parameters affecting all feeds involved into market data processing.

Definition at line 1231 of file FeedSettings.h.

Constructor & Destructor Documentation

FeedSettings ( SettingChangeController *  controller = NULL)
inline

Initializes the instance with the default values.

Definition at line 1387 of file FeedSettings.h.

FeedSettings ( const FeedSettings &  other)
inline

Initializes the instance as a copy of the other one.

Definition at line 1404 of file FeedSettings.h.

Member Function Documentation

const std::string& connectivityConfigurationFile ( ) const
inline

Path to the connectivity configuration file.

Definition at line 1431 of file FeedSettings.h.

FeedSettings& connectivityConfigurationFile ( const std::string &  configurationFile,
DataCenter::Enum  dataCenter = DataCenter::Primary 
)
inline

Path to the connectivity configuration file from which to load feed connection settings.

The given parameter allows retrieving connectivity settings from the connectivity configuration file published by CME instead of manual setup.

Warning
The given parameter has lower priority comparing to feed connection settings. E.g., if connection parameters are manually set up for any of feeds, the Handler will use those parameters to connect to or join multicast groups. The given parameter value is ignored in such a case and thus connectivity configuration is not loaded from the specified file.

For certain environments CME provides additional data centers to be used in case of a disaster. The additional parameter allows specifing whether to load connection settings for either the primary or a disaster recovery data center.

Definition at line 1468 of file FeedSettings.h.

DataCenter::Enum dataCenter ( ) const
inline

Identifies the data center whose parameters are to be extracted from the connectivity configuration file.

The connectivity configuration file may not include attributes for all kinds of data centers.

Definition at line 1442 of file FeedSettings.h.

NetFeedEngine* engine ( ) const
inline

Instance of the Feed Engine to be used by the Handler. Null instance means no feed engine is yet defined.

Definition at line 1638 of file FeedSettings.h.

FeedSettings& engine ( NetFeedEngine *  engine)
inline

Defines instance of the Feed Engine to be used by the Handler.

Definition at line 1645 of file FeedSettings.h.

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

Specifies one or more network interfaces on which to join multicast groups referring to primary (A) feeds.

Multiple interfaces can be specified using semi-colon as a delimiter.

The given member is kind of batch set-up. Manual specification of network interfaces for a particular feed is also possible through the corresponding parameters.

Definition at line 1496 of file FeedSettings.h.

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

Specifies one or more network interfaces on which to join multicast groups referring to secondary (B) feeds.

Multiple interfaces can be specified using semi-colon as a delimiter.

The given member is kind of batch set-up. Manual specification of network interfaces for a particular feed is also possible through the corresponding parameters.

Definition at line 1522 of file FeedSettings.h.

const TcpRecoveryFeedSettings& historicalFeeds ( ) const
inline

The settings related to historical (TCP recovery) feeds.

Definition at line 1624 of file FeedSettings.h.

TcpRecoveryFeedSettings& historicalFeeds ( )
inline

The settings related to historical (TCP Recovery) feeds.

Definition at line 1631 of file FeedSettings.h.

const RealtimeFeedSettings& incrementalFeeds ( ) const
inline

The settings related to incremental feeds.

Definition at line 1564 of file FeedSettings.h.

RealtimeFeedSettings& incrementalFeeds ( )
inline

The settings related to incremental feeds.

Definition at line 1571 of file FeedSettings.h.

const MulticastRecoveryFeedSettings& instrumentFeeds ( ) const
inline

The settings related to instrument feeds.

Definition at line 1579 of file FeedSettings.h.

MulticastRecoveryFeedSettings& instrumentFeeds ( )
inline

The settings related to instrument feeds.

Definition at line 1586 of file FeedSettings.h.

const MulticastRecoveryFeedSettings& mboSnapshotFeeds ( ) const
inline

The settings related to snapshot feeds.

Definition at line 1609 of file FeedSettings.h.

MulticastRecoveryFeedSettings& mboSnapshotFeeds ( )
inline

The settings related to snapshot feeds.

Definition at line 1616 of file FeedSettings.h.

FeedSettings& operator= ( const FeedSettings &  other)
inline

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

Definition at line 1662 of file FeedSettings.h.

PacketSize packetMaxSize ( ) const
inline

Max size for network packet transmitted by MDP.

Note
Default value is '1420'.

Definition at line 1540 of file FeedSettings.h.

FeedSettings& packetMaxSize ( PacketSize  value)
inline

Max size for network packet transmitted by MDP.

Definition at line 1547 of file FeedSettings.h.

const MulticastRecoveryFeedSettings& snapshotFeeds ( ) const
inline

The settings related to snapshot feeds.

Definition at line 1594 of file FeedSettings.h.

MulticastRecoveryFeedSettings& snapshotFeeds ( )
inline

The settings related to snapshot feeds.

Definition at line 1601 of file FeedSettings.h.

Friends And Related Function Documentation

friend class HandlerSettings
friend

Definition at line 1236 of file FeedSettings.h.

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