Represents BATS application. More...

#include <B2BITS_BatsApplication.h>

Public Member Functions
virtual UnitService *	createService (const std::string &channelId, const std::string &symbol, const std::string &expiration, const std::string &putOrCall, const std::string &iface, const RuntimeParameters *params=NULL)=0
	Creates service by channel, and unit params.

virtual UnitService *	createService (const std::string &channelId, System::u8 unitId, const std::string &iface, const RuntimeParameters *params=NULL)=0
	Creates service by channel and unit id.

virtual void	createServices (const std::string &iface, const RuntimeParameters *params=NULL)=0
	Creates all services specified in configuration file.

virtual System::u8	findUnitId (const std::string &channelId, const std::string &symbol, const std::string &expiration, const std::string &putOrCall)=0
	Returns unit Id or throws if unit has not been configured.

virtual const RuntimeParameters &	getChannelParams (const std::string &channelId) const =0
	Returns channel options.

virtual const RuntimeParameters &	getParams () const =0
	Returns application parameters.

virtual UnitService *	getService (const std::string &channelId, const std::string &symbol, const std::string &expiration, const std::string &putOrCall) const =0
	Returns service by channel, and unit params.

virtual UnitService *	getService (const std::string &channelId, System::u8 unitId) const =0
	Returns service by channel and unit id.

virtual UnitService *	getService (unsigned index) const =0
	Returns service by index.

virtual unsigned	getServicesCount () const =0
	Returns the number of created services.

virtual void	release () const =0
	Destroys application.

virtual void	removeService (const std::string &channelId, System::u8 unitId)=0
	Disconnects and destroys a service from the application.

virtual void	removeServices ()=0
	Disconnects and destroys all services from the application.

virtual void	setChannelParams (const std::string &channelId, const RuntimeParameters &params)=0
	Overrides application options for channel.

Detailed Description

Represents BATS application.

Member Function Documentation

◆ createService() [1/2]

virtual UnitService * Bats::Application::createService	(	const std::string &	channelId,
		const std::string &	symbol,
		const std::string &	expiration,
		const std::string &	putOrCall,
		const std::string &	iface,
		const RuntimeParameters *	params = NULL )

pure virtual

Creates service by channel, and unit params.

Parameters

channelId	Id of the channel, specified as channel@id attribute in XML configuration file
symbol	Symbol to subscribe to. Proper unit will be found using unit@coderange attribute in XML configuration file
expiration	unit@expiration attribute in XML configuration file
putOrCall	unit@putorcall attribute in XML configuration file
iface	Address of a local network interface to use when subscribing to multicast feed
params	Runtime parameters, when specified, override current channel's parameters

Returns: pointer to created Bats::UnitService

Exceptions

Utils::Exception if error occurs, usually if service has been misconfigured

Note: If service has already been created this method is equal to getService(const std::string& channelId, const std::string& symbol, const std::string& expiration, const std::string& putOrCall) const

◆ createService() [2/2]

virtual UnitService * Bats::Application::createService	(	const std::string &	channelId,
		System::u8	unitId,
		const std::string &	iface,
		const RuntimeParameters *	params = NULL )

pure virtual

Creates service by channel and unit id.

Parameters

channelId	Id of the channel, specified as channel@id attribute in XML configuration file
unitId	Id of the unit specified as unit@id attribute in XML configuration file
iface	Address of a local network interface to use when subscribing to multicast feed
params	Runtime parameters, when specified, override current channel's parameters

Returns: pointer to created Bats::UnitService

Exceptions

Utils::Exception if error occurs, usually if service has been misconfigured

Note: If service has already been created this method is equal to getService(const std::string& channelId, System::u8 unitId) const

◆ createServices()

virtual void Bats::Application::createServices	(	const std::string &	iface,
		const RuntimeParameters *	params = NULL )

pure virtual

Creates all services specified in configuration file.

Logs error message if some of the service have not been created

Parameters

iface	Address of a local network interface to use when subscribing to multicast feed
params	Runtime parameters, when specified, override current channel's parameters

Exceptions

no

◆ findUnitId()

virtual System::u8 Bats::Application::findUnitId	(	const std::string &	channelId,
		const std::string &	symbol,
		const std::string &	expiration,
		const std::string &	putOrCall )

pure virtual

Returns unit Id or throws if unit has not been configured.

Parameters

channelId	Id of the channel, specified as channel@id attribute in XML configuration file
symbol	Symbol to subscribe to. Proper unit will be found using unit@coderange attribute in XML configuration file
expiration	unit@expiration attribute in XML configuration file
putOrCall	unit@putorcall attribute in XML configuration file

Returns: unit id

Exceptions

Utils::Exception if unit has not been configured

◆ getChannelParams()

virtual const RuntimeParameters & Bats::Application::getChannelParams ( const std::string & channelId ) const

pure virtual

Returns channel options.

Parameters

channelId Id of the channel, specified as channel@id attribute in XML configuration file

Returns: const reference to RuntimeParameters specified for particular channel

Exceptions

Utils::Exception if error occurs

◆ getParams()

virtual const RuntimeParameters & Bats::Application::getParams ( ) const

pure virtual

Returns application parameters.

Returns: const reference to RuntimeParameters passed to Engine::createBatsApplication

Exceptions

no

◆ getService() [1/3]

virtual UnitService * Bats::Application::getService	(	const std::string &	channelId,
		const std::string &	symbol,
		const std::string &	expiration,
		const std::string &	putOrCall ) const

pure virtual

Returns service by channel, and unit params.

Parameters

channelId	Id of the channel, specified as channel@id attribute in XML configuration file
symbol	Symbol to subscribe to. Proper unit will be found using unit@coderange attribute in XML configuration file
expiration	unit@expiration attribute in XML configuration file
putOrCall	unit@putorcall attribute in XML configuration file

Returns: pointer to Bats::UnitService or NULL if service has not been yet created

Exceptions

no

◆ getService() [2/3]

virtual UnitService * Bats::Application::getService	(	const std::string &	channelId,
		System::u8	unitId ) const

pure virtual

Returns service by channel and unit id.

Parameters

channelId	Id of the channel, specified as channel@id attribute in XML configuration file
unitId	Id of the unit specified as unit@id attribute in XML configuration file

Returns: pointer to Bats::UnitService or NULL if service has not been created yet

Exceptions

no

◆ getService() [3/3]

virtual UnitService * Bats::Application::getService ( unsigned index ) const

pure virtual

Returns service by index.

Returns service by zero based index

Parameters

index Zero-based index of the service, must be < getServicesCount()

Returns: pointer to Bats::UnitService or NULL if index is invalid

Exceptions

no

◆ getServicesCount()

virtual unsigned Bats::Application::getServicesCount ( ) const

pure virtual

Returns the number of created services.

You can get a signle service instance using getService(unsigned index) const method

Exceptions

no

◆ release()

virtual void Bats::Application::release ( ) const

pure virtual

Destroys application.

Disconnects and destroys all running services and threads.

Note: Method is synchronous and waits for threads to quit. Calling this method from one of incremental or worker threads will lead to deadlock.

Exceptions

no

◆ removeService()

virtual void Bats::Application::removeService	(	const std::string &	channelId,
		System::u8	unitId )

pure virtual

Disconnects and destroys a service from the application.

Note: Method is asynchronous, it returns immediately. Exact moment when service is removed can be handled with ApplicationListener::onServiceRemoved() notification. It is allowed to call this method from any thread.

Parameters

channelId	Id of the channel, specified as channel@id attribute in XML configuration file
unitId	Id of the unit specified as unit@id attribute in XML configuration file

Exceptions

Utils::Exception if error occurs

◆ removeServices()

virtual void Bats::Application::removeServices ( )

pure virtual

Disconnects and destroys all services from the application.

Note: Method is synchronous and waits for threads to quit. Calling this method from one of incremental or worker threads will lead to deadlock

Exceptions

no

◆ setChannelParams()

virtual void Bats::Application::setChannelParams	(	const std::string &	channelId,
		const RuntimeParameters &	params )

pure virtual

Overrides application options for channel.

Parameters

channelId	Id of the channel, specified as channel@id attribute in XML configuration file
params	parameters for particular channel

Exceptions

Utils::Exception if error occurs

Public Member Functions

Detailed Description

Member Function Documentation

◆ createService() [1/2]

◆ createService() [2/2]

◆ createServices()

◆ findUnitId()

◆ getChannelParams()

◆ getParams()

◆ getService() [1/3]

◆ getService() [2/3]

◆ getService() [3/3]

◆ getServicesCount()

◆ release()

◆ removeService()

◆ removeServices()

◆ setChannelParams()