Message.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.
//

#pragma once

#include <cstdlib>

#include <OnixS/CME/MDH/BinaryMessage.h>

#include <OnixS/CME/MDH/FIX/Field.h>
#include <OnixS/CME/MDH/FIX/Tag.h>

ONIXS_CMEMDHFIX_NAMESPACE_BEGIN

/// The abstraction of a source of FIX information
/// which provides access to the FIX fields by their
/// tags.
struct ONIXS_CMEMDH_EXPORTED FieldSet
{
    /// Returns field by its tag.
    ///
    /// If the source does not contain any
    /// field with the given tag, the returned
    /// instance represents a null field.
    virtual Field field(Tag) const = 0;
};

typedef BinaryGroupEntry<MessageSize> GroupEntrySource;

/// Provides FIX-like access to the fields
/// stored in a SBE-encoded repeating group.
struct ONIXS_CMEMDH_EXPORTED GroupEntryAccessor
{
    /// Provides FIX-like access to the fields
    /// stored in a SBE-encoded repeating group.
    virtual Field field(const GroupEntrySource&, Tag) const = 0;
};

/// Provides FIX-like access to the fields
/// stored in a SBE-encoded repeating group.
class ONIXS_CMEMDH_LTWT GroupEntry : public FieldSet
{
    GroupEntrySource binary_;
    const GroupEntryAccessor* accessor_;

protected:
    friend ONIXS_CMEMDH_LTWT_CLASS_DECL(Group);

    /// Full-initialized instances are
    /// constructed through descendants.
    GroupEntry(const GroupEntrySource& binary, const GroupEntryAccessor& accessor)
        : binary_(binary)
        , accessor_(&accessor)
    {
    }

public:
    /// Initializes the instance which refers to
    /// nothing and thus represents a null instance.
    GroupEntry()
        : binary_()
        , accessor_(ONIXS_CMEMDH_NULLPTR)
    {
    }

    /// Initializes the instance as
    /// the copy of the other one.
    GroupEntry(const GroupEntry& other)
        : binary_(other.binary_)
        , accessor_(other.accessor_)
    {
    }

    /// Indicates whether the instance refers
    /// to a valid repeating group entry.
    operator bool() const
    {
        return (ONIXS_CMEMDH_NULLPTR != accessor_);
    }

    /// Returns field by its tag.
    ///
    /// The instance must refer to a valid group entry.
    Field operator[](Tag tag) const
    {
        return this->field(tag);
    }

    /// Returns field by its tag.
    ///
    /// The instance must refer to a valid group entry.
    Field field(Tag tag) const ONIXS_CMEMDH_OVERRIDE
    {
        assert(ONIXS_CMEMDH_NULLPTR != accessor_);

        return accessor_->field(binary_, tag);
    }

    /// Re-initializes as the
    /// copy of the other instance.
    GroupEntry& operator=(const GroupEntry& other)
    {
        binary_ = other.binary_;
        accessor_ = other.accessor_;

        return *this;
    }
};

typedef BinaryGroupEntries<GroupEntrySource, MessageSize, MessageSize, MessageSize> GroupEntriesSource;

/// Implements a FIX repeating group
/// over the SBE-encoded binary data.
class ONIXS_CMEMDH_LTWT Group
{
    GroupEntriesSource binary_;
    const GroupEntryAccessor* accessor_;

protected:
    /// Initializes the instance over the binary data.
    Group(const GroupEntriesSource& binary, const GroupEntryAccessor& accessor)
        : binary_(binary)
        , accessor_(&accessor)
    {
    }

public:
    /// Number of repeating group entries.
    typedef GroupEntriesSource::Size Size;

    /// Initializes the instance which refers to
    /// nothing and thus represent a null instance.
    Group()
        : accessor_(ONIXS_CMEMDH_NULLPTR)
    {
    }

    /// Initializes as the copy of the other instance.
    Group(const Group& other)
        : binary_(other.binary_)
        , accessor_(other.accessor_)
    {
    }

    /// Indicates whether the instance
    /// refers to a valid repeating group.
    operator bool() const
    {
        return (ONIXS_CMEMDH_NULLPTR != accessor_);
    }

    /// Number of entries in the repeating group
    /// being referred by the given instance.
    Size size() const
    {
        return binary_.size();
    }

    /// Provides access to the group
    /// entry by its index in the group.
    GroupEntry operator[](Size index) const
    {
        assert(ONIXS_CMEMDH_NULLPTR != accessor_);

        return GroupEntry(binary_[index], *accessor_);
    }

    /// Re-initializes as the copy of the other instance.
    Group& operator=(const Group& other)
    {
        binary_ = other.binary_;
        accessor_ = other.accessor_;

        return *this;
    }
};

/// Implements FIX-like services
/// for the SBE-encoded message.
struct ONIXS_CMEMDH_EXPORTED MessageAccessor
{
    /// FIX message type.
    virtual StrRef type() const = 0;

    /// Returns field value by its tag.
    virtual Field field(const BinaryMessage&, Tag) const = 0;

    /// Accesses a repeating group by its tag.
    virtual Group group(const BinaryMessage&, Tag) const = 0;

    /// Serializes the given message into
    /// the FIX (tag=value) presentation.
    virtual void toFix(std::string&, const BinaryMessage&) const = 0;
};

/// Implements FIX-like interface
/// over the SBE-encoded message.
class ONIXS_CMEMDH_LTWT Message : public FieldSet
{
    BinaryMessage binary_;
    const MessageAccessor* accessor_;

protected:
    /// Initializes the instance from the SBE-encoded message.
    Message(const BinaryMessage& binary, const MessageAccessor& accessor)
        : binary_(binary)
        , accessor_(&accessor)
    {
    }

public:
    /// Initializes the message which refers
    /// to nothing and thus being a null-instance.
    Message()
        : binary_()
        , accessor_(ONIXS_CMEMDH_NULLPTR)
    {
    }

    /// Initializes as the copy of the other instance.
    Message(const Message& other)
        : binary_(other.binary_)
        , accessor_(other.accessor_)
    {
    }

    /// Indicates whether the instance refers to a valid message.
    operator bool() const
    {
        return (ONIXS_CMEMDH_NULLPTR != accessor_);
    }

    /// FIX message type.
    StrRef type() const
    {
        assert(ONIXS_CMEMDH_NULLPTR != accessor_);

        return accessor_->type();
    }

    /// Returns a field by its tag.
    ///
    /// If the message contains a field
    /// with the requested tag, then the
    /// returned instance of the Field class
    /// refers to a valid data and thus further
    /// manipulations with its value are possible.
    /// Otherwise, the returned instance refers
    /// to nothing.
    Field operator[](Tag tag) const
    {
        return this->field(tag);
    }

    /// Returns a field by its tag.
    ///
    /// If the message contains a field
    /// with the requested tag, then the
    /// returned instance of the Field class
    /// refers to a valid data and thus further
    /// manipulations with its value are possible.
    /// Otherwise, the returned instance refers
    /// to nothing.
    Field field(Tag tag) const ONIXS_CMEMDH_OVERRIDE
    {
        assert(ONIXS_CMEMDH_NULLPTR != accessor_);

        return accessor_->field(binary_, tag);
    }

    /// Accesses a repeating group by its tag.
    ///
    /// Returns a null instance if the requested
    /// group is not available in the given message.
    Group group(Tag tag) const
    {
        assert(ONIXS_CMEMDH_NULLPTR != accessor_);

        return accessor_->group(binary_, tag);
    }

    /// Builds the FIX (tag=value) representation.
    void toFix(std::string& str) const
    {
        assert(ONIXS_CMEMDH_NULLPTR != accessor_);

        accessor_->toFix(str, binary_);
    }

    /// Re-initializes as the copy of the other instance.
    Message& operator=(const Message& other)
    {
        binary_ = other.binary_;
        accessor_ = other.accessor_;

        return *this;
    }
};

/// Serializes FIX message into tag=value format.
inline void toStr(std::string& str, const Message& message)
{
    message.toFix(str);
}

/// Serializes FIX message into tag=value format.
inline std::string toStr(const Message& message)
{
    std::string str;

    toStr(str, message);

    return str;
}

ONIXS_CMEMDHFIX_NAMESPACE_END