IDecodeListener.h

Go to the documentation of this file.

/*
* Copyright Onix Solutions Limited [OnixS]. All rights reserved.
*
* This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
* and international copyright treaties.
*
* Access to and use of the software is governed by the terms of the applicable ONIXS Software
* Services Agreement (the Agreement) and Customer end user license agreements granting
* a non-assignable, non-transferable and non-exclusive license to use the software
* for it's own data processing purposes under the terms defined in the Agreement.
*
* Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
* of this source code or associated reference material to any other location for further reproduction
* or redistribution, and any amendments to this copyright notice, are expressly prohibited.
*
* Any reproduction or redistribution for sale or hiring of the Software not in accordance with
* the terms of the Agreement is a violation of copyright law.
*/

#if !defined(__ONIXS_IDECODELISTENER_H__)
#define __ONIXS_IDECODELISTENER_H__

#include <cstddef>

#include <OnixS/FIXEngine/ABI.h>
#include <OnixS/FIXEngine/Compiler.h>

namespace OnixS {
namespace FIX {
namespace FAST {
/// The decode session's listener.
/// This interface declares set of methods called by the EventBasedDecoder during the decoding process.
class ONIXS_FIXENGINE_API IDecodeListener
{
public:
    /// @note The FIX Engine does NOT manage the lifetime of this listener.
    virtual ~IDecodeListener() ONIXS_FIXENGINE_DEFAULT;

    /// @name Entire message events
    /// These events belongs to the entire message. Events occur single time per message.

    /// @{
    /// Called when a new FAST-encoded message found in input data.
    ///
    /// @param templateId The identifier of the FAST template belonged to the message.
    /// @param messageType The FIX type of the message.
    /// @param messageTypeLength The length of the messageType string. Doe not include the terminating zero.
    virtual void onBeginMessage(unsigned templateId, const char * messageType,
                                size_t messageTypeLength) = 0;

    /// Called when the decoder finishes the current message decoding.
    /// @note It is possible to reset the caller decoder during this callback.
    virtual void onEndMessage() = 0;
    /// @}

    /// @name Data field events
    /// These events denotes that particular fields were decoded. Events occurs once per a field.

    /// @{
    /// Called when a signed 32-bit integer field decoded.
    ///
    /// @param tag The FIX tag of the field.
    /// @param value the decoded value.
    virtual void onValue(int tag, int value) = 0;

    /// Called when an unsigned 32-bit integer field decoded.
    ///
    /// @param tag The FIX tag of the field.
    /// @param value the decoded value.
    virtual void onValue(int tag, unsigned value) = 0;

    /// Called when a signed 64-bit integer field decoded.
    ///
    /// @param tag The FIX tag of the field.
    /// @param value the decoded value.
    virtual void onValue(int tag, long long value) = 0;

    /// Called when an unsigned 64-bit integer field decoded.
    ///
    /// @param tag The FIX tag of the field.
    /// @param value the decoded value.
    virtual void onValue(int tag, unsigned long long value) = 0;

    /// Called when a decimal field decoded.
    ///
    /// @param tag The FIX tag of the field.
    /// @param mantissa The mantissa of the decoded decimal value.
    /// @param exponent The exponent of the decoded decimal value (in range of -64..63).
    virtual void onValue(int tag, long long mantissa, int exponent) = 0;

    /// Called when a string (ASCII or Unicode) or byteVector decoded.
    ///
    /// @param tag The FIX tag of the field.
    /// @param value The pointer to start of decoded data.
    /// @param valueLength The length of the decoded data (does not include the terminating zero for &lt;string&gt; fields).
    virtual void onValue(int tag, const char * value, size_t valueLength) = 0;
    /// @}

    /// @name Sequence events
    /// These callbacks embraces the sequence decoding. Each callback called once per a sequence unless the sequence is empty.

    /// @{
    /// Called just before first entry of the sequence decoding.
    ///
    /// @param tag The Tag of the sequence
    /// @param itemCount The number of entries in the sequence.
    /// @param lengthFieldTag The Tag of the &lt;length&gt; field.
    virtual void onBeginSequence(int tag, size_t itemCount, int lengthFieldTag) = 0;

    /// Called immediately after the last sequence entry decoded.
    virtual void onEndSequence() = 0;
    /// @}

    /// @name Sequence entry events
    /// These callbacks embraces sequence entry decoding. Each callback called once per sequence entry.

    /// @{
    /// Called just before the sequence entry decoding.
    /// @param index The index of the entry.
    virtual void onBeginSequenceEntry(size_t index) = 0;

    /// Called after the entry was decoded.
    virtual void onEndSequenceEntry() = 0;
    /// @}
};
}
}
}

#endif // __ONIXS_IDECODELISTENER_H__