FAST_1-1.h

Go to the documentation of this file.

/*
* (c) Onix Solutions.
*/

#ifndef FAST_1_1_H
#define FAST_1_1_H

#include "FIXEngineDefines.h"
#include "EngineException.h"

#include <string>
#include <vector>

namespace FIXForge{
namespace FIX{
class FF_API Message;

namespace FAST_1_1{

/// Encodes FIX messages into FAST 1.1 representation.
class FF_API Encoder{
public:
    /**
     * Constructor. Creates a FIX to FAST Encoder. 
     *
     * @param xmlTemplates XML-based FAST 1.1 templates.
     * @param fixVersion FIX Protocol version.
     * @param encodeEachMessageIndependently Option to reset the previous values dictionaries before encoding a new FIX message.
     */
    Encoder(const std::string& xmlTemplates, FIXForge::FIX::Version fixVersion, bool encodeEachMessageIndependently);

    /// Destructor.
    ~Encoder(void); 

    /**
     * Encodes the given FIX message into a FAST 1.1 stream.  
     * 
     * @param fixMessage Source FIX message to be encoded.
     * @param templateID FAST Template Identifier which uniquely describes the encoding/decoding rules.
     * @param buffer Supplied buffer that will contain the FAST stream chunk.
     * @param bufferSize Size of the supplied buffer.
     *
     * @return the size of the encoded FAST stream chunk.
     */
    size_t encode(const FIXForge::FIX::Message& fixMessage, int templateID, char* buffer, size_t bufferSize);

        /**
     * Encodes the given FIX message into a FAST 1.1 stream using the default template ID. 
     * 
     * @param fixMessage Source FIX message to be encoded.   
     * @param buffer Supplied buffer that will contain the FAST stream chunk.
     * @param bufferSize Size of the supplied buffer.
     *
     * @return the size of the encoded FAST stream chunk.
     */
    size_t encode(const FIXForge::FIX::Message& fixMessage, char* buffer, size_t bufferSize);

    /**
     * Resets the state of the previous values dictionaries (sets the state of the previous values to undefined). 
     *
     * @see encodeEachMessageIndependently.
     */
    void reset();

private:
    Encoder(const Encoder&);
    Encoder& operator = (const Encoder&);

    Encoder(void* native);          

    struct Impl;
    Impl* impl_;
    void* native_;
};

/// Performs FAST 1.1 to FIX decoding. 
class FF_API Decoder{
public:
    /**
    * Constructor. Creates a FAST 1.1 to FIX Decoder.
    *
    * @param xmlTemplates XML-based FAST 1.1 templates.
    * @param fixVersion FIX Protocol version.
    * @param decodeEachMessageIndependently Option to reset the previous values dictionaries before decoding a new FAST stream chunk.
    */
    Decoder(const std::string& xmlTemplates, FIXForge::FIX::Version fixVersion, bool decodeEachMessageIndependently);

    /// Destructor.
    ~Decoder(void); 

    /**
    * Decodes the given FAST 1.1 stream chunk into the corresponding FIX Message. 
    * 
    * @param buffer Buffer that contains the FAST stream chunk to be decoded.
    * @param bufferSize Size of the buffer.
    *
    * @throw EngineException if the message cannot be decoded.  
    *
    * @return the decoded FIX message.
    */
    const FIXForge::FIX::Message& decode(const char* buffer, size_t bufferSize);

    /**
    * Decodes the given FAST 1.1 stream chunk into the corresponding FIX Message. 
    * 
    * @param chunk The FAST stream chunk to be decoded.
    *
    * @throw EngineException if the message cannot be decoded.  
    *
    * @return the decoded FIX message.
    */
    const FIXForge::FIX::Message& decode(const std::vector<char> & chunk);

    
    bool decode(const char* buffer, size_t offset, size_t count, const FIXForge::FIX::Message** message, size_t* chunkLengh);
    
    /**
     * Decoded the FAST-encoded unsigned integer.
     *
     * @param buffer Buffer that contains the FAST stream chunk to be decoded.
     * @param bufferSize Size of the buffer.
     * @param value Decoded value.
     * @param fieldLength Number of bytes that contained the encoded value.
     *
     * @return 'true' if the stop bit was found and the value was decoded, otherwise - 'false'.
     */
    static bool decodeUnsignedInteger(const char* buffer, size_t bufferSize, unsigned int* value, size_t* fieldLength);

    /**
     * Resets the state of the previous values dictionaries (sets the state of the previous values to undefined). 
     *
     * @see decodeEachMessageIndependently.
     */
    void reset();

private:
    Decoder(const Decoder&);
    Decoder& operator = (const Decoder&);

    Decoder(void* native);          

    struct Impl;
    Impl* impl_;
    void* native_;
};



}}};

#endif

---