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 <OnixS/CME/iLink3/messaging/SbeMessage.h>
#include <OnixS/CME/iLink3/messaging/TagBased/Field.h>
#include <OnixS/CME/iLink3/messaging/TagBased/Tag.h>
 
#include <cstdlib>
 
ONIXS_ILINK3_MESSAGING_TAGBASED_NAMESPACE_BEGIN

ONIXS_ILINK3_EXPORTED_STRUCT
FieldAccessor
{
    virtual Field field(const BinaryBlockBase&, Tag) const ONIXS_ILINK3_NOTHROW = 0;

    virtual void setField(BinaryBlockBase&, Tag, const Field&) const = 0;

    virtual void resetField(BinaryBlockBase&, Tag) const = 0;

    virtual void reset(BinaryBlockBase&) const ONIXS_ILINK3_NOTHROW = 0;
 
protected:
    ~FieldAccessor() ONIXS_ILINK3_DEFAULT;
};

ONIXS_ILINK3_EXPORTED_STRUCT FieldSet
{
    ONIXS_ILINK3_EXPLICIT operator bool() const ONIXS_ILINK3_NOTHROW
    {
        return (ONIXS_ILINK3_NULLPTR != accessor_);
    }

    FieldSet& reset() ONIXS_ILINK3_NOTHROW
    {
        accessor_->reset(binary_);
 
        return *this;
    }

    ONIXS_ILINK3_NODISCARD Field field(Tag tag) const ONIXS_ILINK3_NOTHROW
    {
        assert(accessor_);
 
        return accessor_->field(binary_, tag);
    }

    FieldSet& setField(
        Tag tag, const Field& field)
    {
        assert(accessor_);
        assert(field);
 
        accessor_->setField(binary_, tag, field);
 
        return *this;
    }

    FieldSet& resetField(Tag tag)
    {
        assert(accessor_);
 
        accessor_->resetField(binary_, tag);
 
        return *this;
    }

    ONIXS_ILINK3_NODISCARD Field operator [](Tag tag) const ONIXS_ILINK3_NOTHROW
    {
        return this->field(tag);
    }

    ONIXS_ILINK3_NODISCARD bool contain(Tag tag) const ONIXS_ILINK3_NOTHROW;

    ONIXS_ILINK3_NODISCARD Char getChar(Tag tag) const;

    ONIXS_ILINK3_NODISCARD Int64 getInt64(Tag tag) const;

    ONIXS_ILINK3_NODISCARD UInt64 getUInt64(Tag tag) const;

    ONIXS_ILINK3_NODISCARD Int32 getInt32(Tag tag) const;

    ONIXS_ILINK3_NODISCARD UInt32 getUInt32(Tag tag) const;

    ONIXS_ILINK3_NODISCARD Int16 getInt16(Tag tag) const;

    ONIXS_ILINK3_NODISCARD UInt16 getUInt16(Tag tag) const;

    ONIXS_ILINK3_NODISCARD Int8 getInt8(Tag tag) const;

    ONIXS_ILINK3_NODISCARD UInt8 getUInt8(Tag tag) const;

    ONIXS_ILINK3_NODISCARD Decimal getDecimal(Tag tag) const;

    ONIXS_ILINK3_NODISCARD StrRef getStringRef(Tag tag) const;

    ONIXS_ILINK3_NODISCARD Timestamp getTimestamp(Tag tag) const;

    MaturityMonthYear getMaturityMonthYear(Tag tag) const;

    template <typename Enumeration>
    ONIXS_ILINK3_NODISCARD typename Enumeration::Enum getEnumeration(Tag tag) const
    {
        return field(tag).cast<Enumeration>();
    }

    template <typename BitSet>
    ONIXS_ILINK3_NODISCARD BitSet getBitSet(Tag tag) const
    {
        return BitSet(field(tag).cast<typename BitSet::Bits>());
    }

    FieldSet& set(Tag tag, const Field& field)
    {
        return setField(tag, field);
    }

    template <typename BitSet>
    FieldSet& set(Tag tag, BitSet value, typename BitSet::Bits* = ONIXS_ILINK3_NULLPTR)
    {
        return set(tag, value.bits());
    }

    FieldSet& set(Tag tag, Char value);

    FieldSet& set(Tag tag, UInt64 value);

    FieldSet& set(Tag tag, Int64 value);

    FieldSet& set(Tag tag, UInt32 value);

    FieldSet& set(Tag tag, Int32 value);

    FieldSet& set(Tag tag, UInt16 value);

    FieldSet& set(Tag tag, Int16 value);

    FieldSet& set(Tag tag, UInt8 value);

    FieldSet& set(Tag tag, Int8 value);

    FieldSet& set(Tag tag, const Decimal& value);

    FieldSet& set(Tag tag, StrRef value);

    FieldSet& set(Tag tag, Timestamp value);

    FieldSet& set(Tag tag, const MaturityMonthYear& value);
 
protected:
    ~FieldSet() ONIXS_ILINK3_DEFAULT;

    FieldSet(
        BinaryBlockBase& binary,
        const FieldAccessor* accessor)
        ONIXS_ILINK3_NOTHROW
        : binary_(binary)
        , accessor_(accessor)
    {
    }

    const FieldAccessor* accessor() const ONIXS_ILINK3_NOTHROW
    {
        return accessor_;
    }

    void setAccessor(const FieldAccessor* obj) ONIXS_ILINK3_NOTHROW
    {
        accessor_ = obj;
    }
 
private:
    BinaryBlockBase& binary_;
    const FieldAccessor* accessor_;
};
 
typedef
SbeGroupEntry<MessageSize>
GroupEntrySource;

ONIXS_ILINK3_EXPORTED_STRUCT
GroupEntryAccessor : public FieldAccessor
{
protected:
    ~GroupEntryAccessor() ONIXS_ILINK3_DEFAULT;
};

ONIXS_ILINK3_LTWT_CLASS
GroupEntry : public FieldSet
{
public:
    GroupEntry() ONIXS_ILINK3_NOTHROW
        : FieldSet(binary_, ONIXS_ILINK3_NULLPTR)
        , binary_()
    {
    }

    GroupEntry(const GroupEntry& r) ONIXS_ILINK3_NOTHROW
        : FieldSet(binary_, r.accessor())
        , binary_(r.binary_)
    {
    }

    GroupEntry& operator =(const GroupEntry& r) ONIXS_ILINK3_NOTHROW
    {
        setAccessor(r.accessor());
        this->binary_ = r.binary_;
 
        return *this;
    }
 
protected:
    friend
    ONIXS_ILINK3_LTWT_CLASS_DECL
    (
        Group
    );

    GroupEntry(const GroupEntrySource& binary, const GroupEntryAccessor& accessor) ONIXS_ILINK3_NOTHROW
        : FieldSet(binary_, &accessor)
        , binary_(binary)
    {
    }
 
private:
    GroupEntrySource binary_;
};
 
typedef
SbeGroupEntries
<
    GroupEntrySource,
    MessageSize,
    MessageSize,
    MessageSize
>
GroupEntriesSource;

ONIXS_ILINK3_LTWT_CLASS Group
{
public:
    typedef
    GroupEntriesSource::Size
    Size;

    Group()
        : accessor_(ONIXS_ILINK3_NULLPTR)
    {
    }

    ONIXS_ILINK3_EXPLICIT operator bool() const ONIXS_ILINK3_NOTHROW
    {
        return (ONIXS_ILINK3_NULLPTR != accessor_);
    }

    Size size() const ONIXS_ILINK3_NOTHROW
    {
        return binary_.size();
    }

    GroupEntry operator [](Size index) const
    {
        assert(accessor_);
        assert(binary_.valid());
 
        return GroupEntry(binary_[index], *accessor_);
    }
 
protected:
    Group(const GroupEntriesSource& binary, const GroupEntryAccessor& accessor) ONIXS_ILINK3_NOTHROW
        : binary_(binary)
        , accessor_(&accessor)
    {
    }
 
private:
    GroupEntriesSource binary_;
    const GroupEntryAccessor* accessor_;
};

ONIXS_ILINK3_EXPORTED_STRUCT
MessageAccessor : public FieldAccessor
{
    virtual StrRef type() const ONIXS_ILINK3_NOTHROW = 0;

    virtual Group group(const SbeMessage&, Tag) const ONIXS_ILINK3_NOTHROW = 0;

    virtual Group group(SbeMessage&, Tag, MessageSize) const = 0;

    virtual MessageSize calculateBinarySize(const SbeMessage&) const ONIXS_ILINK3_NOTHROW = 0;

    virtual void toFix(std::string&, const SbeMessage&) const = 0;

    std::string toFix(const SbeMessage&, Char delimiter) const;
 
protected:
    ~MessageAccessor() ONIXS_ILINK3_DEFAULT;
};

ONIXS_ILINK3_LTWT_CLASS
Message : public FieldSet
{
public:
    Message() ONIXS_ILINK3_NOTHROW
        : FieldSet(binary_, ONIXS_ILINK3_NULLPTR)
        , binary_()
    {
    }

    Message(const Message& r) ONIXS_ILINK3_NOTHROW
        : FieldSet(binary_, r.accessor())
        , binary_(r.binary_)
    {
    }

    Message& operator = (const Message& r) ONIXS_ILINK3_NOTHROW
    {
        setAccessor(r.accessor());
        this->binary_ = r.binary_;
 
        return *this;
    }

    StrRef type() const ONIXS_ILINK3_NOTHROW
    {
        return accessor()->type();
    }

    Group group(Tag tag) const ONIXS_ILINK3_NOTHROW
    {
        assert(binary_.valid());
 
        return accessor()->group(binary_, tag);
    }

    Group group(Tag tag, MessageSize size)
    {
        assert(binary_.valid());
 
        return accessor()->group(binary_, tag, size);
    }

    ONIXS_ILINK3_NODISCARD StrRef getVarData(Tag tag) const
    {
        return field(tag).cast<StrRef>();
    }

    Message& setVarData(Tag tag, StrRef value)
    {
        set(tag, value);
 
        return *this;
    }

    ONIXS_ILINK3_NODISCARD MessageSize calculateBinarySize() const ONIXS_ILINK3_NOTHROW
    {
        assert(binary_.valid());
 
        return accessor()->calculateBinarySize(binary_);
    }

    void toFix(std::string& str) const
    {
        accessor()->toFix(str, binary_);
    }

    ONIXS_ILINK3_NODISCARD std::string toFix(Char delimiter = '\x1') const
    {
        return accessor()->toFix(binary_, delimiter);
    }

    ONIXS_ILINK3_NODISCARD std::string toString() const
    {
        return accessor()->toFix(binary_, '|');
    }

    ONIXS_ILINK3_NODISCARD SchemaVersion version() const
    {
        assert(accessor());
        assert(binary_.valid());
 
        return binary_.version();
    }

    ONIXS_ILINK3_NODISCARD MessageTemplateId templateId() const
    {
        assert(accessor());
        assert(binary_.valid());
 
        return binary_.templateId();
    }
 
protected:
    Message(SbeMessage binary, const MessageAccessor& accessor) ONIXS_ILINK3_NOTHROW
        : FieldSet(binary_, &accessor)
        , binary_(binary)
    {
    }
 
    ~Message() ONIXS_ILINK3_DEFAULT;
 
private:
    const MessageAccessor* accessor() const ONIXS_ILINK3_NOTHROW
    {
        const FieldAccessor* const parentAccessor = FieldSet::accessor();
 
        assert(parentAccessor);
        assert(dynamic_cast<const MessageAccessor*>(parentAccessor));
 
        return static_cast<const MessageAccessor*>(parentAccessor);
    }
 
private:
    SbeMessage binary_;
};

inline void toStr(std::string& str, const Message& message)
{
    message.toFix(str);
}

inline std::string toStr(const Message& message)
{
    std::string str;
 
    toStr(str, message);
 
    return str;
}

inline std::ostream& operator<<(std::ostream& stream, const Message& msg)
{
    return stream << msg.toString();
}
 
ONIXS_ILINK3_MESSAGING_TAGBASED_NAMESPACE_END