Encoder Class Reference

Public Member Functions
	Encoder (const std::string &xmlTemplates, ISbeCustomCoderLibrary *customCoders=ONIXS_FIXENGINE_NULLPTR)
	~Encoder (void)
size_t	encode (const OnixS::FIX::Message &fixMessage, int templateID, int version, unsigned char *buffer, size_t bufferSize, size_t *rootBlockLength) const
size_t	encodeWithHeader (const OnixS::FIX::Message &fixMessage, int templateID, int version, unsigned char *buffer, size_t bufferSize, size_t *rootBlockLength) const
unsigned	schemaVersion () const
unsigned	schemaId () const
std::string	schemaSemanticVersion () const
std::string	schemaHeaderType () const

Detailed Description

Definition at line 38 of file SBE.h.

Constructor & Destructor Documentation

Encoder()

Encoder	(	const std::string &	xmlTemplates,
		ISbeCustomCoderLibrary *	customCoders = ONIXS_FIXENGINE_NULLPTR )

Creates a FIX to SBE Encoder.

Parameters

xmlTemplates	XML-based SBE templates.
customCoders	The custom coders library.

~Encoder()

~Encoder

(

void

)

Destructor.

Member Function Documentation

encode()

size_t encode	(	const OnixS::FIX::Message &	fixMessage,
		int	templateID,
		int	version,
		unsigned char *	buffer,
		size_t	bufferSize,
		size_t *	rootBlockLength ) const

Encodes the given FIX message into a SBE stream.

Parameters

[in]	fixMessage	The source FIX message to be encoded.
[in]	templateID	the SBE Template Identifier which uniquely describes the encoding/decoding rules.
[in]	version	The version of the template.
[in]	buffer	The supplied buffer that will contain the SBE stream chunk.
[in]	bufferSize	The size of the supplied buffer.
[out]	rootBlockLength	The size of the root block, used for the encoded message.

Returns

The size of the entire encoded SBE message.

encodeWithHeader()

size_t encodeWithHeader	(	const OnixS::FIX::Message &	fixMessage,
		int	templateID,
		int	version,
		unsigned char *	buffer,
		size_t	bufferSize,
		size_t *	rootBlockLength ) const

Encodes the given FIX message into a SBE stream and prepends the message header.

Parameters

[in]	fixMessage	The source FIX message to be encoded.
[in]	templateID	The SBE Template Identifier which uniquely describes the encoding/decoding rules.
[in]	version	The version of the template.
[in]	buffer	The supplied buffer that will contain the SBE stream chunk.
[in]	bufferSize	The size of the supplied buffer.
[out]	rootBlockLength	The size of the root block, used for the encoded message.

Returns

The size of the entire encoded SBE message.

schemaHeaderType()

std::string schemaHeaderType

(

)

const

The name of the encoding type of the message header, which is the same for all messages in a schema.

schemaId()

unsigned schemaId

(

)

const

The schema identifier.

schemaSemanticVersion()

std::string schemaSemanticVersion

(

)

const

The semantic version of the SBE schema.

schemaVersion()

unsigned schemaVersion

(

)

const

The maximum known version of the SBE schema.