B2BITS CME MDP Handler API Reference
Public Member Functions | Protected Member Functions | List of all members
MarketDataService Class Referenceabstract

Market Data Service. More...

#include <B2BITS_CmeMdpMarketDataService.h>

Public Member Functions

virtual std::string getName () const =0
 Returns market data service name. More...
 
virtual const
MarketDataServiceOptions
getOptions () const =0
 Returns market data service options. More...
 
virtual bool opened () const =0
 Indicates if the market data service is opened. More...
 
virtual void open ()=0
 Initializes market data service. More...
 
virtual void close ()=0
 Finalizes market data service. More...
 
virtual ChannelgetChannel (ChannelID id)=0
 Returns channel by channel id. More...
 
virtual void getChannels (ChannelVector *channelVector)=0
 Returns all channels of the market data service. More...
 
virtual ChannelfindChannel (ChannelID id)=0
 Finds channel by channel id. More...
 
virtual ChanneladdChannel (ChannelID id, const ChannelOptions &channelOptions)=0
 Adds a new channel to the market data service. More...
 
virtual void removeChannel (ChannelID id)=0
 Removes channel from the market data service. More...
 
virtual void removeChannels ()=0
 Removes all channels from the market data service. More...
 
virtual void destroy ()=0
 Destroys market data service. More...
 

Protected Member Functions

virtual ~MarketDataService ()
 

Detailed Description

MarketDataService is the root object to access CME market data. MarketDataService object maintains a collection of channels.

Constructor & Destructor Documentation

virtual ~MarketDataService ( )
inlineprotectedvirtual

Member Function Documentation

virtual std::string getName ( ) const
pure virtual
Returns
Name of the market data service.
virtual const MarketDataServiceOptions& getOptions ( ) const
pure virtual
Returns
Options of the market data service.
virtual bool opened ( ) const
pure virtual
Returns
True if the market data service is opened.
virtual void open ( )
pure virtual

Loads channel and template configuration files. Adds channes defined in the channel configuraiton file.

virtual void close ( )
pure virtual
virtual Channel* getChannel ( ChannelID  id)
pure virtual
Parameters
idId of the channel to return.
Returns
Reference to the channel.
Exceptions
Generatesexception if the channel doesn't exist.
virtual void getChannels ( ChannelVector channelVector)
pure virtual
Parameters
channelVectorVector of channel references to fill.
virtual Channel* findChannel ( ChannelID  id)
pure virtual
Parameters
idId of the channel to return.
Returns
Reference to the channel. Returns null if the channel doesn't exist.
virtual Channel* addChannel ( ChannelID  id,
const ChannelOptions channelOptions 
)
pure virtual
Parameters
idId of the channel to add.
optionsOptions of the channel to add.
Returns
Reference to the channel added.
Exceptions
Generatesexception if the channel already exists.
virtual void removeChannel ( ChannelID  id)
pure virtual
Parameters
idId of the channel to remove.
virtual void removeChannels ( )
pure virtual
virtual void destroy ( )
pure virtual
Note
The instance reference is no longer valid.