OnixS C++ FIX Engine  4.2.0
API Documentation
EventBasedDecoder Class Reference

#include <OnixS/FIXEngine/FIX/SbeEventBasedDecoder.h>

Public Member Functions

 EventBasedDecoder (const std::string &xmlTemplates)
 
 ~EventBasedDecoder ()
 
bool decodeSingleMessage (int version, int templateId, size_t rootBlockLength, const unsigned char *buffer, size_t offset, size_t count, IDecodeListener *listener, size_t *numberOfDecodedBytes) const
 
unsigned schemaVersion () const
 
unsigned schemaId () const
 
std::string schemaSemanticVersion () const
 
std::string schemaHeaderType () const
 

Detailed Description

Definition at line 40 of file SbeEventBasedDecoder.h.

Constructor & Destructor Documentation

EventBasedDecoder ( const std::string &  xmlTemplates)

Creates SBE to FIX Decoder.

Parameters
xmlTemplatesXML-based SBE templates.

Destructor.

Member Function Documentation

bool decodeSingleMessage ( int  version,
int  templateId,
size_t  rootBlockLength,
const unsigned char *  buffer,
size_t  offset,
size_t  count,
IDecodeListener listener,
size_t *  numberOfDecodedBytes 
) const

Tries to decode the given FAST stream buffer into the corresponding FIX Message.

Parameters
[in]templateIdIdentifier of the SBE template, used to decode the input data.
[in]versionVersion of the SBE schema, used to decode the input data.
[in]rootBlockLengthLength of the root block. This value should be extracted from the message preamble, or from other source.
[in]bufferThe FAST stream chunk to be decoded.
[in]offsetThe index in the buffer at which decoding begins.
[in]countNumber of bytes to analyze during the decoding.
[in]listenerListener which receives decoding events.
[out]numberOfDecodedBytesNumber of bytes that contained the encoded FIX Message.
Warning
message should point to an existing object. This object is not owned by Decoder and should be managed by user.
Exceptions
Exceptionif the decoding error is detected.
Returns
'true' if the given bytes could be decoded into a FIX message, otherwise - 'false'.
std::string schemaHeaderType ( ) const

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

unsigned schemaId ( ) const

Schema identifier.

std::string schemaSemanticVersion ( ) const

Semantic version of the SBE schema.

unsigned schemaVersion ( ) const

Maximum known version of the SBE schema.


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