OnixS C++ FIX Engine  4.2.0
API Documentation
IDecodeListener Class Referenceabstract

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

Public Member Functions

virtual ~IDecodeListener ()
 
Entire message events

These events belongs to entire message.

Events occur single time per message.

virtual void onBeginMessage (unsigned templateId, const char *messageType, size_t messageTypeLength)=0
 
virtual void onEndMessage ()=0
 
Data field events

These events denotes that particular fields were decoded.

Events occurs once per field.

virtual void onValue (int tag, int value)=0
 
virtual void onValue (int tag, unsigned value)=0
 
virtual void onValue (int tag, long long value)=0
 
virtual void onValue (int tag, unsigned long long value)=0
 
virtual void onValue (int tag, long long mantissa, int exponent)=0
 
virtual void onValue (int tag, const char *value, size_t valueLength)=0
 
Sequence events

These callbacks embraces sequence decoding.

Each callback called once per sequence unless the sequence is empty.

virtual void onBeginSequence (int tag, size_t itemCount, int lengthFieldTag)=0
 
virtual void onEndSequence ()=0
 
Sequence entry events

These callbacks embraces sequence entry decoding.

Each callback called once per sequence entry.

virtual void onBeginSequenceEntry (size_t index)=0
 
virtual void onEndSequenceEntry ()=0
 
Field group events

These callbacks embraces group decoding.

Each callback called once per group unless the is empty.

virtual void onBeginGroup (int tag)=0
 
virtual void onEndGroup ()=0
 

Detailed Description

This interface declares set of methods called by EventBasedDecoder during decoding process.

Definition at line 32 of file IDecodeListener.h.

Constructor & Destructor Documentation

virtual ~IDecodeListener ( )
inlinevirtual
Note
FIX Engine does NOT manage the lifetime of this listener.

Definition at line 36 of file IDecodeListener.h.

Member Function Documentation

virtual void onBeginGroup ( int  tag)
pure virtual

Fired before first field of the group will be searched in input data.

Parameters
tagTag of the group.
virtual void onBeginMessage ( unsigned  templateId,
const char *  messageType,
size_t  messageTypeLength 
)
pure virtual

Called when a new FAST-encoded message found in input data.

Parameters
templateIdIdentifier of FAST template belonged to the message.
messageTypeFIX type of the message.
messageTypeLengthLength of the messageType string. Doe not include terminating zero.
virtual void onBeginSequence ( int  tag,
size_t  itemCount,
int  lengthFieldTag 
)
pure virtual

Called just before first entry of the sequence decoding.

Parameters
tagTag of the sequence
itemCountNumber of entries in the sequence.
lengthFieldTagTag of the <length> field.
virtual void onBeginSequenceEntry ( size_t  index)
pure virtual

Called just before sequence entry decoding.

Parameters
indexIndex of the entry.
virtual void onEndGroup ( )
pure virtual

Fired after last field of the group decoded.

virtual void onEndMessage ( )
pure virtual

Called when decoder finishes current message decoding.

Note
It is possible to reset caller decoder during this callback.
virtual void onEndSequence ( )
pure virtual

Called immediately after the last sequence entry decoded.

virtual void onEndSequenceEntry ( )
pure virtual

Called after the entry was decoded.

virtual void onValue ( int  tag,
int  value 
)
pure virtual

Called when signed 32-bit integer field decoded.

Parameters
tagFIX tag of the field.
valueDecoded value.
virtual void onValue ( int  tag,
unsigned  value 
)
pure virtual

Called when unsigned 32-bit integer field decoded.

Parameters
tagFIX tag of the field.
valueDecoded value.
virtual void onValue ( int  tag,
long long  value 
)
pure virtual

Called when signed 64-bit integer field decoded.

Parameters
tagFIX tag of the field.
valueDecoded value.
virtual void onValue ( int  tag,
unsigned long long  value 
)
pure virtual

Called when unsigned 64-bit integer field decoded.

Parameters
tagFIX tag of the field.
valueDecoded value.
virtual void onValue ( int  tag,
long long  mantissa,
int  exponent 
)
pure virtual

Called when decimal field decoded.

Parameters
tagFIX tag of the field.
mantissaMantissa of the decoded decimal value.
exponentExponent of the decoded decimal value (in range of -64..63).
virtual void onValue ( int  tag,
const char *  value,
size_t  valueLength 
)
pure virtual

Called when a string (ASCII or Unicode) or byteVector decoded.

Parameters
tagFIX tag of the field.
valuePointer to start of decoded data.
valueLengthLength of decoded data (does not include terminating zero for <string> fields).

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