Engine::FastCodec Class Reference

A factory for FastCoder and FastDecoder. More...

#include <B2BITS_FastCodec.h>

Public Member Functions
std::unique_ptr< FastCoder >	createFastCoder (const std::string &pathToAdditionalXml, const std::string &pathToTemplatesXml, const std::string &scpProtocolName, const std::string &appProtocolName, const FastMappingOptions &mappingOptions=FastMappingOptions())
	Creates FastCoder.
std::unique_ptr< FastCoder >	createFastCoder (const std::string &pathToAdditionalXml, const std::string &pathToTemplatesXml, FIXVersion scpVer, FIXVersion appVer, const FastMappingOptions &mappingOptions=FastMappingOptions())
	Creates FastCoder.
std::unique_ptr< FastDecoder >	createFastDecoder (const std::string &pathToAdditionalXml, const std::string &pathToTemplatesXml, const std::string &scpProtocolName, const std::string &appProtocolName, const FastMappingOptions &mappingOptions=FastMappingOptions())
	Creates FastDecoder.
std::unique_ptr< FastDecoder >	createFastDecoder (const std::string &pathToAdditionalXml, const std::string &pathToTemplatesXml, FIXVersion scpVer, FIXVersion appVer, const FastMappingOptions &mappingOptions=FastMappingOptions())
	Creates FastDecoder.
std::unique_ptr< FastScp11::Decoder >	createFastScp11Decoder (std::string const &template_fn, std::string const &protocol_customization_fn, std::string const &scp_protocol_ver, std::string const &app_protocol_ver, FastScp11::Decoder::Listener *listener, const FastMappingOptions &mappingOptions=FastMappingOptions())
	Functions generator used to create FastScp11::Decoder.
	FastCodec (const std::string &pathToLicense)
	Constructor.
	~FastCodec ()

Protected Member Functions
	FastCodec (const FastCodec &)
FastCodec &	operator= (const FastCodec &)

Detailed Description

A factory for FastCoder and FastDecoder.

Constructor & Destructor Documentation

FastCodec() [1/2]

Engine::FastCodec::FastCodec

(

const std::string &

pathToLicense

)

Constructor.

Parameters

[in]

pathToLicense

- a path to a license file

Exceptions

an	exception if the specified license is not valid

~FastCodec()

Engine::FastCodec::~FastCodec

(

)

FastCodec() [2/2]

Engine::FastCodec::FastCodec ( const FastCodec & )

protected

Member Function Documentation

createFastCoder() [1/2]

std::unique_ptr< FastCoder > Engine::FastCodec::createFastCoder	(	const std::string &	pathToAdditionalXml,
		const std::string &	pathToTemplatesXml,
		const std::string &	scpProtocolName,
		const std::string &	appProtocolName,
		const FastMappingOptions &	mappingOptions = FastMappingOptions() )

Creates FastCoder.

Parameters

[in]	pathToAdditionalXml	- path to additional xml; can be empty
[in]	pathToTemplatesXml	- path to a xml file which contains templates
[in]	scpProtocolName	- a trasnport protocol name
[in]	appProtocolName	- an application protocol name
[in]	mappingOptions	- mapping options of coder

Returns

- new instance of FastCoder class

createFastCoder() [2/2]

std::unique_ptr< FastCoder > Engine::FastCodec::createFastCoder	(	const std::string &	pathToAdditionalXml,
		const std::string &	pathToTemplatesXml,
		FIXVersion	scpVer,
		FIXVersion	appVer,
		const FastMappingOptions &	mappingOptions = FastMappingOptions() )

Creates FastCoder.

Parameters

[in]	pathToAdditionalXml	- path to additional xml; can be empty
[in]	pathToTemplatesXml	- path to a xml file which contains templates
[in]	scpVer	- a trasnport protocol version
[in]	appVer	- an application protocol version
[in]	mappingOptions	- mapping options of coder

Returns

- new instance of FastCoder class

createFastDecoder() [1/2]

std::unique_ptr< FastDecoder > Engine::FastCodec::createFastDecoder	(	const std::string &	pathToAdditionalXml,
		const std::string &	pathToTemplatesXml,
		const std::string &	scpProtocolName,
		const std::string &	appProtocolName,
		const FastMappingOptions &	mappingOptions = FastMappingOptions() )

Creates FastDecoder.

Parameters

[in]	pathToAdditionalXml	- path to additional xml; can be empty
[in]	pathToTemplatesXml	- path to a xml file which contains templates
[in]	scpProtocolName	- a trasnport protocol name
[in]	appProtocolName	- an application protocol name
[in]	mappingOptions	- mapping options of decoder

Returns

- new instance of FastDecoder class

createFastDecoder() [2/2]

std::unique_ptr< FastDecoder > Engine::FastCodec::createFastDecoder	(	const std::string &	pathToAdditionalXml,
		const std::string &	pathToTemplatesXml,
		FIXVersion	scpVer,
		FIXVersion	appVer,
		const FastMappingOptions &	mappingOptions = FastMappingOptions() )

Creates FastDecoder.

Parameters

[in]	pathToAdditionalXml	- path to additional xml; can be empty
[in]	pathToTemplatesXml	- path to a xml file which contains templates
[in]	scpVer	- a trasnport protocol version
[in]	appVer	- an application protocol version
[in]	mappingOptions	- mapping options of decoder

Returns

- new instance of FastDecoder class

createFastScp11Decoder()

std::unique_ptr< FastScp11::Decoder > Engine::FastCodec::createFastScp11Decoder	(	std::string const &	template_fn,
		std::string const &	protocol_customization_fn,
		std::string const &	scp_protocol_ver,
		std::string const &	app_protocol_ver,
		FastScp11::Decoder::Listener *	listener,
		const FastMappingOptions &	mappingOptions = FastMappingOptions() )

Functions generator used to create FastScp11::Decoder.

Parameters

[in]	template_fn	- path to fast template file
[in]	protocol_customization_fn	- semicolon separated list of xml files that contains description of FIX session protol messages and FIX market data protocol messages
[in]	scp_protocol_ver	- name of the FIX SCP protocol (FIXT11 usual)
[in]	app_protocol_ver	- name of the FIX protocol (FIX40, FIX41, ... FIX50SP1CME)
[in]	listener	- listener of "on scp message" events (OnFastHello, OnFastAlert, OnFastReset). Can be NULL value. FastScp11::Decoder resets Dictionaris before calling OnFastReset.
[in]	mappingOptions	- mapping options of decoder

Returns

instance of FastScp11::Decoder class

Exceptions

-	an std::exception with detailed information if an error occurs.

operator=()

FastCodec & Engine::FastCodec::operator= ( const FastCodec & )

protected