SbeMessage.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/B3/BOE/ABI.h>
#include <OnixS/B3/BOE/messaging/Aliases.h>
#include <OnixS/B3/BOE/messaging/StrRef.h>
#include <OnixS/B3/BOE/messaging/Memory.h>
#include <OnixS/B3/BOE/messaging/Composites.h>
#include <OnixS/B3/BOE/messaging/SchemaTraits.h>
#include <OnixS/B3/BOE/messaging/MaxMessageSize.h>
#include <OnixS/B3/BOE/messaging/ExceptionHelpers.h>
 
#include <cassert>
#include <limits>
#include <stdexcept>
 
ONIXS_B3_BOE_MESSAGING_NAMESPACE_BEGIN

typedef
MessageHeader::TemplateId MessageTemplateId;

template<typename Message> inline
void checkBinaryLength(const Message&, MessageSize length, MessageSize minimalRequiredLength)
{
    if ONIXS_B3_BOE_UNLIKELY(length < minimalRequiredLength)
        throwBinaryBlockIsTooSmall(length, minimalRequiredLength, Message::className());
}

ONIXS_B3_BOE_LTWT_CLASS BinaryBlockBase
{
protected:
    ~BinaryBlockBase() ONIXS_B3_BOE_DEFAULT;
};

template < class Container, class BlockLength >
ONIXS_B3_BOE_LTWT_CLASS BinaryBlock : public BinaryBlockBase
{
    const Container& container() const ONIXS_B3_BOE_NOTHROW
    {
        return *static_cast <const Container*> (this);
    }
 
protected:
    BinaryBlock() ONIXS_B3_BOE_DEFAULT;
 
    ~BinaryBlock() ONIXS_B3_BOE_DEFAULT;

    template < class Value > ONIXS_B3_BOE_HOTPATH
    Value ordinary(BlockLength offset) const ONIXS_B3_BOE_NOTHROW
    {
        assert(container().blockLength() >= (offset + size<Value>()) &&
            "The requested field exceeds provided block boundaries.");
 
        const void* const location = advanceByBytes(container().block(), offset);
        return getValue<Value>(location);
    }

    template < class Value > ONIXS_B3_BOE_HOTPATH
    const Value& accessOrdinary(BlockLength offset) const ONIXS_B3_BOE_NOTHROW
    {
        assert(container().blockLength() >= (offset + size<Value>()) &&
            "The requested field exceeds provided block boundaries.");
 
        const void* location = advanceByBytes(container().block(), offset);
        const Value* valuePtr = static_cast<const Value*>(location);
        return *valuePtr;
    }

    template < class Value > ONIXS_B3_BOE_HOTPATH
    Value& accessOrdinary(BlockLength offset) ONIXS_B3_BOE_NOTHROW
    {
        return const_cast<Value&>(static_cast<const BinaryBlock<Container, BlockLength> &>(*this).accessOrdinary<Value>(offset));
    }

    template <class Value, class NullValue > ONIXS_B3_BOE_HOTPATH
    bool ordinary(Value& value, BlockLength offset, NullValue null) const ONIXS_B3_BOE_NOTHROW
    {
        value = ordinary<Value>(offset);
 
        return (null != value);
    }

    template < class Value, class NullValue > ONIXS_B3_BOE_HOTPATH
    bool ordinary(Value& value, BlockLength offset, NullValue null, SchemaVersion since) const ONIXS_B3_BOE_NOTHROW
    {
        return (since <= container().version()  && ordinary (value, offset, null ) );
    }

    template < class Enumeration > ONIXS_B3_BOE_HOTPATH
    typename Enumeration::Enum enumeration(BlockLength offset) const ONIXS_B3_BOE_NOTHROW
    {
        typedef typename Enumeration::Base Base;
        typedef typename Enumeration::Enum Enum;
 
        return static_cast<Enum>(ordinary<Base>(offset));
    }

    template < class Enumeration, class NullValue > ONIXS_B3_BOE_HOTPATH
    bool enumeration(typename Enumeration::Enum& value, BlockLength offset, NullValue null) const ONIXS_B3_BOE_NOTHROW
    {
        typedef typename Enumeration::Base Base;
        typedef typename Enumeration::Enum Enum;
 
        value = static_cast <Enum>(ordinary<Base>(offset));
        return null != value;
    }

    template < class Enumeration, class NullValue > ONIXS_B3_BOE_HOTPATH
    bool enumeration(typename Enumeration::Enum& value, BlockLength offset, NullValue null, SchemaVersion since) const ONIXS_B3_BOE_NOTHROW
    {
        return (since <= container().version() && enumeration<Enumeration>(value, offset, null) );
    }

    template < class Value > ONIXS_B3_BOE_HOTPATH
    Value decimal(BlockLength offset) const ONIXS_B3_BOE_NOTHROW
    {
        return ordinary<Value>(offset);
    }

    template < class Value, class NullValue > ONIXS_B3_BOE_HOTPATH
    bool decimal(Value& value, BlockLength offset, NullValue null) const ONIXS_B3_BOE_NOTHROW
    {
        value = ordinary<Value>(offset);
        return null != value;
    }

    template < class Value, class NullValue > ONIXS_B3_BOE_HOTPATH
    bool decimal(Value& value, BlockLength offset, NullValue null, SchemaVersion since) const ONIXS_B3_BOE_NOTHROW
    {
        return (since <= container().version() && decimal(value, offset, null));
    }

    template < BlockLength Length > ONIXS_B3_BOE_HOTPATH
    StrRef fixedStr(BlockLength offset) const ONIXS_B3_BOE_NOTHROW
    {
        assert(container().blockLength() >= (offset + Length) && "The requested field exceeds provided block boundaries.");
 
        const Char* const text = reinterpret_cast <const Char*> (advanceByBytes(container().block(), offset));
 
        return StrRef(text, strnlen(text, Length));
    }

    template<BlockLength Length> ONIXS_B3_BOE_HOTPATH
    bool fixedStr(StrRef& value, BlockLength offset) const ONIXS_B3_BOE_NOTHROW
    {
        value = fixedStr<Length>(offset);
        return !value.empty();
    }

    template<BlockLength Length> ONIXS_B3_BOE_HOTPATH
    bool fixedStr(StrRef& value, BlockLength offset, SchemaVersion since) const ONIXS_B3_BOE_NOTHROW
    {
        return (since <= container().version() && fixedStr<Length>(value, offset));
    }
};

template <class Container, class BlockLength >
ONIXS_B3_BOE_LTWT_CLASS SbeFields : public BinaryBlock<Container, BlockLength>
{
public:
    Container& container() ONIXS_B3_BOE_NOTHROW
    {
        return *static_cast<Container*>(this);
    }

    ONIXS_B3_BOE_HOTPATH
    void zeroPaddingBytes(BlockLength offset) ONIXS_B3_BOE_NOTHROW
    {
        const BlockLength encodedBlockLength = container().blockLength();
 
        assert(encodedBlockLength >= offset);
 
        const size_t paddingLength = encodedBlockLength - offset;
        std::memset(advanceByBytes(container().block(), offset), 0, paddingLength);
    }

    template<class FieldValue> ONIXS_B3_BOE_HOTPATH
    void setOrdinary(BlockLength offset, FieldValue value) ONIXS_B3_BOE_NOTHROW
    {
        assert(container().blockLength() >= (offset + size<FieldValue>()) && "The requested field exceeds provided block boundaries.");
 
        void* const fieldPos = advanceByBytes(container().block(), offset);
        setValue(fieldPos, value);
    }

    template<class FieldValue> ONIXS_B3_BOE_HOTPATH
    void setOrdinary(BlockLength offset, FieldValue value, SchemaVersion since)
    {
        if ONIXS_B3_BOE_UNLIKELY(since > container().version())
            throwDisallowedField();
 
        setOrdinary(offset, value);
    }

    template<class Enumeration> ONIXS_B3_BOE_HOTPATH
    void setEnumeration(BlockLength offset, typename Enumeration::Enum value) ONIXS_B3_BOE_NOTHROW
    {
        typedef typename Enumeration::Base Base;
        setOrdinary<Base>(offset, static_cast<Base>(value));
    }

    template<class Enumeration> ONIXS_B3_BOE_HOTPATH
    void setEnumeration(BlockLength offset, typename Enumeration::Enum value, SchemaVersion since)
    {
        typedef typename Enumeration::Base Base;
        setOrdinary(offset, static_cast<Base>(value), since);
    }

    template<BlockLength Size> ONIXS_B3_BOE_HOTPATH
    void setFixedStr(BlockLength offset, StrRef value) ONIXS_B3_BOE_NOTHROW
    {
        assert(container().blockLength() >= (offset + Size) && "The requested field exceeds provided block boundaries.");
        assert(value.size() <= Size && "The string is truncated.");
 
        void* const fieldPos = advanceByBytes(container().block(), offset);
        const size_t sizeToCopy = (std::min)(Size, static_cast<BlockLength>(value.size()));
 
        if(sizeToCopy > 0)
            std::memcpy(fieldPos, value.data(), sizeToCopy);
 
        std::memset(advanceByBytes(fieldPos, sizeToCopy), 0, Size - sizeToCopy);
    }

    template<BlockLength Size> ONIXS_B3_BOE_HOTPATH
    void setFixedStr(BlockLength offset, StrRef value, SchemaVersion since)
    {
        if ONIXS_B3_BOE_UNLIKELY(since > container().version())
            throwDisallowedField();
 
        setFixedStr<Size>(offset, value);
    }
 
protected:
    SbeFields() ONIXS_B3_BOE_DEFAULT;
 
    ~SbeFields() ONIXS_B3_BOE_DEFAULT;
};

template <class BodySizeType>
ONIXS_B3_BOE_LTWT_CLASS SbeGroupEntry : public SbeFields<SbeGroupEntry<BodySizeType>, BodySizeType>
{
public:
    typedef BodySizeType BlockLength;

    SbeGroupEntry()
        : encoded_(ONIXS_B3_BOE_NULLPTR)
        , size_(0)
        , version_(0)
    {
    }

    ONIXS_B3_BOE_HOTPATH
    SbeGroupEntry(void* encoded, BlockLength size, SchemaVersion version)
        : encoded_(encoded)
        , size_(size)
        , version_(version)
    {
        assert(encoded);
    }

    bool valid() const ONIXS_B3_BOE_NOTHROW
    {
        return (encoded_ != ONIXS_B3_BOE_NULLPTR);
    }

    const void* encoded() const ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return encoded_;
    }

    void* encoded() ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return encoded_;
    }

    const void* block() const ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return encoded_;
    }

    void* block() ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return encoded_;
    }

    BlockLength blockLength() const ONIXS_B3_BOE_NOTHROW
    {
        return size_;
    }

    SchemaVersion version() const ONIXS_B3_BOE_NOTHROW
    {
        return version_;
    }
 
    private:
    void* encoded_;
    BodySizeType size_;
    SchemaVersion version_;
};

template <class EntryType, class BlockLength, class NumInGroup, class Length >
ONIXS_B3_BOE_LTWT_CLASS SbeGroupEntries
{
public:
    typedef Length EncodedLength;

    typedef EntryType Entry;

    typedef NumInGroup Size;

    ONIXS_B3_BOE_LTWT_CLASS Iterator
    {
    public:
        typedef EntryType Entry;
        typedef Entry value_type;
 
        typedef Entry* pointer;
        typedef Entry& reference;
 
        typedef ptrdiff_t difference_type;
 
        typedef std::random_access_iterator_tag iterator_category;

        Iterator() ONIXS_B3_BOE_NOTHROW
            : entry_(ONIXS_B3_BOE_NULLPTR)
            , size_(0)
            , version_(0)
        {
        }

        ONIXS_B3_BOE_HOTPATH
        Iterator(void* entry, EncodedLength size, SchemaVersion version) ONIXS_B3_BOE_NOTHROW
            : entry_(entry)
            , size_(size)
            , version_(version)
        {
            assert(valid());
        }

        bool valid() const ONIXS_B3_BOE_NOTHROW
        {
            return (entry_ != ONIXS_B3_BOE_NULLPTR);
        }

        ONIXS_B3_BOE_HOTPATH
        Entry get() const
        {
            assert(valid());
 
            return Entry(entry_, size_, version_);
        }

        Entry operator *() const
        {
            return get();
        }

        bool operator == (const Iterator& other) const ONIXS_B3_BOE_NOTHROW
        {
            return entry_ == other.entry_;
        }

        bool operator !=(const Iterator& other) const ONIXS_B3_BOE_NOTHROW
        {
            return entry_ != other.entry_;
        }

        bool operator < (const Iterator& other) const ONIXS_B3_BOE_NOTHROW
        {
            return entry_ < other.entry_;
        }

        bool operator > (const Iterator& other) const ONIXS_B3_BOE_NOTHROW
        {
            return entry_ > other.entry_;
        }

        Iterator& operator ++()
        {
            assert(valid());
 
            entry_ = advanceByBytes(entry_, size_);
 
            return *this;
        }

        Iterator& operator --()
        {
            assert(valid());
 
            entry_ = advanceBackByBytes(entry_, size_);
 
            return *this;
        }

        ONIXS_B3_BOE_HOTPATH
        Iterator operator +(difference_type distance) const
        {
            assert(valid());
 
            return Iterator(advanceByBytes(entry_, distance * size_), size_, version_);
        }

        ONIXS_B3_BOE_HOTPATH
        Iterator operator - (difference_type distance) const
        {
            assert(valid());
 
            return Iterator(advanceBackByBytes(entry_, distance * size_), size_, version_);
        }
 
        private:
        void* entry_;
        EncodedLength size_;
        SchemaVersion version_;
    };

    SbeGroupEntries() ONIXS_B3_BOE_NOTHROW
        : encoded_(ONIXS_B3_BOE_NULLPTR)
        , blockLength_(0)
        , size_(0)
        , version_(0)
    {
    }

    SbeGroupEntries(void* encoded, BlockLength blockLength, Size groupSize, SchemaVersion version) ONIXS_B3_BOE_NOTHROW
        : encoded_(encoded)
        , blockLength_(blockLength)
        , size_(groupSize)
        , version_(version)
    {
        assert(encoded_);
        assert(blockLength > 0);
        assert(version != 0);
    }

    bool valid() const ONIXS_B3_BOE_NOTHROW
    {
        return (ONIXS_B3_BOE_NULLPTR != encoded_);
    }

    bool empty() const ONIXS_B3_BOE_NOTHROW
    {
        return (0 == size_);
    }

    Size size() const ONIXS_B3_BOE_NOTHROW
    {
        return size_;
    }

    Iterator begin() const
    {
        return Iterator(encoded(), blockLength_, version_);
    }

    Iterator end() const
    {
        return Iterator(advanceByBytes(encoded(), encodedLength()), blockLength_, version_);
    }

    Entry operator [](Size index) const
    {
        assert(index < size_);
        assert(encoded_);
 
        return Entry(advanceByBytes(encoded_, static_cast<ptrdiff_t>(index) * blockLength_), blockLength_, version_);
    }

    void* encoded() const ONIXS_B3_BOE_NOTHROW
    {
        return encoded_;
    }

    EncodedLength encodedLength() const ONIXS_B3_BOE_NOTHROW
    {
        return (static_cast<EncodedLength>(blockLength_) * static_cast<EncodedLength>(size_) );
    }

    template<class OtherEntry, class OtherBlockLength, class OtherNumInGroup, class OtherLength >
    SbeGroupEntries(const SbeGroupEntries<OtherEntry, OtherBlockLength, OtherNumInGroup, OtherLength >& other) ONIXS_B3_BOE_NOTHROW
        : encoded_(other.encoded_)
        , blockLength_(other.blockLength_)
        , size_(other.size_)
        , version_(other.version_)
    {
        // Dimension types may vary for the different instantiations of the template.
        // Therefore, truncation of the dimensions must be avoided.
 
        assert(blockLength_ == other.blockLength_);
        assert(size_ == other.size_);
    }
 
    template <class OtherEntry, class OtherBlockLength, class OtherNumInGroup, class OtherLength>
    SbeGroupEntries& operator = (const SbeGroupEntries <OtherEntry, OtherBlockLength, OtherNumInGroup, OtherLength>& other) ONIXS_B3_BOE_NOTHROW
    {
        encoded_ = other.encoded_;
 
        blockLength_ = other.blockLength_;
 
        assert(blockLength_ == other.blockLength_);
 
        size_ = other.size_;
 
        assert(size_ == other.size_);
 
        version_ = other.version_;
 
        return *this;
    }
 
private:
    // Allows coping and cloning for different instantiations.
    template <class OtherEntry, class OtherBlockLength, class OtherNumInGroup, class OtherLength> friend class SbeGroupEntries;
 
    void* encoded_;
    BlockLength blockLength_;
    NumInGroup size_;
    SchemaVersion version_;
};

template < class EntryType, class DimensionType, class GroupSizeType >
ONIXS_B3_BOE_LTWT_CLASS SbeGroup
{
public:
    typedef DimensionType Dimension;

    typedef GroupSizeType BinarySize;

    enum { EmptySize = Dimension::Size };

    typedef typename DimensionType::BlockLength EntrySize;

    typedef SbeGroupEntries <EntryType, typename Dimension::BlockLength, typename Dimension::NumInGroup, GroupSizeType > Entries;

    typedef typename Entries::Iterator Iterator;

    typedef typename Entries::Entry Entry;

    typedef typename Entries::Size Size;

    SbeGroup()
        ONIXS_B3_BOE_NOTHROW
        : header_(ONIXS_B3_BOE_NULLPTR)
        , entries_(ONIXS_B3_BOE_NULLPTR)
        , version_(0)
    {
    }

    ONIXS_B3_BOE_HOTPATH
    SbeGroup(void* data, ONIXS_B3_BOE_UNUSED BinarySize size, SchemaVersion version) ONIXS_B3_BOE_NOTHROW
        : header_(static_cast <Dimension*>(data))
        , entries_(advanceByBytes(data, Dimension::Size))
        , version_(version)
    {
        ONIXS_B3_BOE_ASSERT(size >= Dimension::Size);
        assert(header_);
        assert(entries_);
 
        assert(valid());
    }

    bool valid() const ONIXS_B3_BOE_NOTHROW
    {
        return (entries_ != ONIXS_B3_BOE_NULLPTR);
    }

    bool empty() const ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return 0 == size();
    }

    ONIXS_B3_BOE_HOTPATH
    Size size() const ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
        assert(header_);
 
        const Dimension* const group = static_cast<const Dimension*>(header_);
 
        return group->numInGroup();
    }

    ONIXS_B3_BOE_HOTPATH
    Iterator begin() const ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return Iterator(entries_, numericCast<EntrySize>(entrySize()), version_);
    }

    ONIXS_B3_BOE_HOTPATH
    Iterator end() const ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return Iterator(advanceByBytes(binary(), binarySize()), numericCast<EntrySize>(entrySize()), version_);
    }

    ONIXS_B3_BOE_HOTPATH
    Entry operator [](Size index) const
    {
        assert(valid());
        assert(index < size());
 
        return Entry(advanceByBytes(entries_, static_cast<ptrdiff_t>(index) * entrySize()), entrySize(), version_);
    }

    ONIXS_B3_BOE_NODISCARD
    Entries entries() const ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
        assert(header_);
 
        return Entries (entries_, header_->blockLength(), header_->numInGroup(), version_);
    }

    const void* encoded() const ONIXS_B3_BOE_NOTHROW
    {
        return header_;
    }

    const void* tail() const ONIXS_B3_BOE_NOTHROW
    {
        return advanceByBytes(toByteBlock(encoded()), binarySize());
    }

    ONIXS_B3_BOE_HOTPATH
    void* binary() const ONIXS_B3_BOE_NOTHROW
    {
        return header_;
    }

    ONIXS_B3_BOE_HOTPATH
    BinarySize binarySize() const ONIXS_B3_BOE_NOTHROW
    {
        return Dimension::Size + (static_cast<BinarySize>(entrySize()) * static_cast<BinarySize>(size()));
    }

    ONIXS_B3_BOE_HOTPATH
    EntrySize entrySize() const ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
        assert(header_);
 
        Dimension* const group = static_cast<Dimension*>(header_);
        return group->blockLength();
    }
 
private:
    void init(EntrySize entrySize) ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
        assert(header_);
 
        Dimension* const group = static_cast<Dimension*>(header_);
        group->setBlockLength(entrySize);
        group->setNumInGroup(0);
    }

    Size allocate(Size entryCount, const void* messageTail, const void* blockEnd)
    {
        assert(valid());
        assert(blockEnd);
        assert(messageTail);
 
        Dimension* const group = static_cast<Dimension*>(header_);
 
        const EntrySize entrySize = group->blockLength();
 
        if ONIXS_B3_BOE_UNLIKELY(
            entrySize < EntryType::blockLength(version_))
        {
            throwBadBinaryBlock();
        }
 
        const Size oldEntryCount = group->numInGroup();
 
        if(oldEntryCount == entryCount)
            return entryCount;
 
        const ptrdiff_t memShift =
            (entryCount - oldEntryCount) * static_cast<ptrdiff_t>(entrySize);
 
        const void* const newMessageTail =
            advanceByBytes(messageTail, memShift);
 
        if ONIXS_B3_BOE_UNLIKELY(byteDistance(blockEnd, newMessageTail) < 0)
            throwNotEnoughSpace();
 
        const void* const oldEndOfGroup =
            advanceByBytes(entries_, static_cast<ptrdiff_t>(entrySize) * oldEntryCount);
 
        void* const newEndGroup =
            advanceByBytes(entries_, static_cast<ptrdiff_t>(entrySize) * entryCount);
 
        std::memmove(
            newEndGroup,
            oldEndOfGroup,
            byteDistance(messageTail, oldEndOfGroup));
 
        group->setNumInGroup(entryCount);
 
        return oldEntryCount;
    }

    ONIXS_B3_BOE_HOTPATH
    void setup(Size entryCount, const void* messageTail, const void* blockEnd)
    {
        assert(valid());
        assert(blockEnd);
        assert(messageTail);
 
        const Size oldEntryCount = allocate(entryCount, messageTail, blockEnd);
 
        for(Size index = oldEntryCount; index < entryCount; ++index)
            zeroPaddingBytes((*this)[index].resetVariableFields());
    }

    ONIXS_B3_BOE_HOTPATH
    void construct(Size entryCount, const void* messageTail, const void* blockEnd)
    {
        assert(valid());
        assert(blockEnd);
        assert(messageTail);
 
        const Size oldEntryCount = allocate(entryCount, messageTail, blockEnd);
 
        for(Size index = oldEntryCount; index < entryCount; ++index)
            zeroPaddingBytes((*this)[index].reset());
    }
 
    ONIXS_B3_BOE_HOTPATH
    static void zeroPaddingBytes(Entry& entry)
    {
        assert(entry.valid());
        entry.zeroPaddingBytes(EntryType::minimalBlockLength(entry.version()));
    }
 
private:
    Dimension* header_;
    void* entries_;
    SchemaVersion version_;
 
    friend class SbeMessage;
};

template < class BinarySize >
ONIXS_B3_BOE_LTWT_CLASS SbeVariableLengthFieldList
{
public:
    ONIXS_B3_BOE_HOTPATH
    SbeVariableLengthFieldList(void* binary, BinarySize size, SchemaVersion version) ONIXS_B3_BOE_NOTHROW
        : binary_(binary)
        , size_(size)
        , version_(version)
    {
    }

    bool empty() const ONIXS_B3_BOE_NOTHROW
    {
        return (0 == size_);
    }

    template<class BinaryVariableLengthFieldType>
    BinaryVariableLengthFieldType& head() const ONIXS_B3_BOE_NOTHROW
    {
        return *static_cast<BinaryVariableLengthFieldType*>(binary_);
    }

    template<class BinaryVariableLengthFieldType> ONIXS_B3_BOE_HOTPATH
    SbeVariableLengthFieldList tail() const ONIXS_B3_BOE_NOTHROW
    {
        assert(!empty());
 
        const BinarySize headSize = head<BinaryVariableLengthFieldType>().binarySize();
 
        assert(headSize <= size_);
 
        return SbeVariableLengthFieldList(advanceByBytes( binary_, headSize), size_ - headSize, version_);
    }

    template<class BinaryVariableLengthFieldType> ONIXS_B3_BOE_HOTPATH
    SbeVariableLengthFieldList checkTail() const
    {
        if ONIXS_B3_BOE_UNLIKELY(empty() || (size_ < BinaryVariableLengthFieldType::Size))
        {
            throwBadBinaryBlock();
        }
 
        const BinarySize headSize = head<BinaryVariableLengthFieldType>().binarySize();
 
        if ONIXS_B3_BOE_UNLIKELY(headSize > size_)
        {
            throwBadBinaryBlock();
        }
 
        return SbeVariableLengthFieldList(advanceByBytes(binary_, headSize), size_ - headSize, version_);
    }
 
    private:
    void* binary_;
    BinarySize size_;
    SchemaVersion version_;
 
};

template  <class BinarySize>
ONIXS_B3_BOE_LTWT_CLASS SbeGroupList
{
public:
    ONIXS_B3_BOE_HOTPATH
    SbeGroupList(void* binary, BinarySize size, SchemaVersion version) ONIXS_B3_BOE_NOTHROW
        : binary_(binary)
        , size_(size)
        , version_(version)
    {
    }

    bool empty() const ONIXS_B3_BOE_NOTHROW
    {
        return (0 == size_);
    }

    template<class Group> ONIXS_B3_BOE_HOTPATH
    Group head() const ONIXS_B3_BOE_NOTHROW
    {
        assert(!empty());
 
        return Group(binary_, size_, version_);
    }

    template<class Group> ONIXS_B3_BOE_HOTPATH
    SbeGroupList tail() const ONIXS_B3_BOE_NOTHROW
    {
        assert(!empty());
 
        const BinarySize headSize = head<Group>().binarySize();
 
        assert(headSize <= size_);
 
        return SbeGroupList(advanceByBytes(binary_, headSize), size_ - headSize, version_);
    }

    template <class Group> ONIXS_B3_BOE_HOTPATH
    SbeVariableLengthFieldList<BinarySize> variableLengthFields() const ONIXS_B3_BOE_NOTHROW
    {
        assert(!empty());
 
        const BinarySize headSize = head<Group>().binarySize();
 
        assert(headSize <= size_);
 
        return SbeVariableLengthFieldList<BinarySize>(advanceByBytes(binary_, headSize), size_ - headSize, version_);
    }

    template<class Group> ONIXS_B3_BOE_HOTPATH
    SbeGroupList checkTail() const
    {
        const BinarySize headSize = checkHead<Group>();
 
        return SbeGroupList(advanceByBytes(binary_, headSize), size_ - headSize, version_);
    }

    template <class Group> ONIXS_B3_BOE_HOTPATH
    SbeVariableLengthFieldList<BinarySize> checkVariableLengthFields() const
    {
        const BinarySize headSize = checkHead<Group>();
 
        return SbeVariableLengthFieldList<BinarySize>(advanceByBytes(binary_, headSize), size_ - headSize, version_);
    }
 
private:
    template<class Group>
    BinarySize checkHead() const
    {
        if ONIXS_B3_BOE_UNLIKELY(size_ < Group::Dimension::Size)
        {
            throwBadBinaryBlock();
        }
 
        const Group group = head<Group>();
 
        const BinarySize headSize = group.binarySize();
 
        if ONIXS_B3_BOE_UNLIKELY(headSize > size_)
        {
            throwBadBinaryBlock();
        }
 
        if(!group.empty())
        {
            const BinarySize entrySize = group.entrySize();
            const BinarySize expectedEntrySize = Group::Entry::minimalBlockLength(version_);
 
            if ONIXS_B3_BOE_UNLIKELY(entrySize < expectedEntrySize)
            {
                throwBadBinaryBlock();
            }
        }
 
        return headSize;
    }
 
    void* binary_;
    BinarySize size_;
    SchemaVersion version_;
};

template<typename Traits>
void checkVersion(SchemaVersion version)
{
    if ONIXS_B3_BOE_UNLIKELY(version < Traits::MinimalVersion)
    {
        throwBadMessageVersion(version, Traits::MinimalVersion);
    }
}

template<typename Traits>
void checkVersion(SchemaVersion since, SchemaVersion version)
{
    checkVersion<Traits>(version);
 
    if ONIXS_B3_BOE_UNLIKELY(version < since)
    {
        throwBadMessageVersion(version, since);
    }
}

template<typename Traits>
void checkSchemaId(SchemaId id)
{
    if ONIXS_B3_BOE_UNLIKELY(id != Traits::Id)
    {
        throwBadSchemaId(Traits::Id, id);
    }
}

template<typename Traits>
void checkSchema(SchemaId id, SchemaVersion version)
{
    checkSchemaId<Traits>(id);
    checkVersion<Traits>(version);
}

ONIXS_B3_BOE_LTWT_CLASS SbeMessage : public SbeFields<Messaging::SbeMessage, MessageSize>
{
public:
    struct NoFieldsInit{};
    struct NoInit{};
    struct NoCheck{};

    typedef MessageSize EncodedLength;

    typedef MessageSize BlockLength;

    SbeMessage() ONIXS_B3_BOE_NOTHROW
        : header_(ONIXS_B3_BOE_NULLPTR)
        , size_(0)
    {
    }

    ONIXS_B3_BOE_HOTPATH
    SbeMessage(void* data, MessageSize size, SchemaVersion version)
        : header_(static_cast<MessageHeader*>(data))
        , size_(size)
    {
        assert(data);
        assert(size <= MaxB3BOEMessageSize);
 
        if ONIXS_B3_BOE_UNLIKELY(size < MessageHeader::Size)
            throwBinaryBlockIsTooSmall(size, MessageHeader::Size);
 
        this->version(version);
    }

    ONIXS_B3_BOE_HOTPATH
    SbeMessage(void* data, MessageSize size)
        : header_(static_cast<MessageHeader*>(data))
        , size_(size)
    {
        assert(data);
        assert(size <= MaxB3BOEMessageSize);
 
        if ONIXS_B3_BOE_UNLIKELY(size < MessageHeader::Size)
            throwBinaryBlockIsTooSmall(size, MessageHeader::Size);
 
        // Now it is safe to read header_.
        if ONIXS_B3_BOE_UNLIKELY(size < (MessageHeader::Size + header_->blockLength()))
            throwBinaryBlockIsTooSmall(size, MessageHeader::Size + header_->blockLength());
    }

    ONIXS_B3_BOE_HOTPATH
    SbeMessage(void* data, MessageSize size, NoCheck) ONIXS_B3_BOE_NOTHROW
        : header_(static_cast<MessageHeader*>(data))
        , size_(size)
    {
        assert(data);
        assert(size <= MaxB3BOEMessageSize);
 
        assert(size >= MessageHeader::Size);
        assert(size >= MessageHeader::Size + header_->blockLength());
    }

    void clear() ONIXS_B3_BOE_NOTHROW
    {
        *this = SbeMessage();
        assert(!valid());
    }

    bool valid() const ONIXS_B3_BOE_NOTHROW
    {
        return (ONIXS_B3_BOE_NULLPTR != header_);
    }

    MessageTemplateId templateId() const ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return header_->templateId();
    }

    SchemaVersion version() const ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return header_->version();
    }

    SchemaId schemaId() const ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return header_->schemaId();
    }

    const void* binary() const ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return header_;
    }

    void* binary() ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return header_;
    }
 
    // \return the end of the memory block.
    const void* blockEnd() ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return advanceByBytes(header_, size_);
    }
 
    // \return the end of the memory block.
    const void* blockEnd() const ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return advanceByBytes(header_, size_);
    }

    MessageSize bufferSize() const ONIXS_B3_BOE_NOTHROW
    {
        return size_;
    }

    void* body() ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return advanceByBytes(header_, MessageHeader::Size);
    }

    BlockLength blockLength() const ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return header_->blockLength();
    }

    const void* block() const ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return advanceByBytes(header_, MessageHeader::Size);
    }

    void* block() ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        return advanceByBytes(header_, MessageHeader::Size);
    }
 
protected:
    typedef SbeGroupList<MessageSize> GroupList;

    SbeMessage& version(SchemaVersion version) ONIXS_B3_BOE_NOTHROW
    {
        assert(valid());
 
        header_->setVersion(version);
 
        return *this;
    }

    ONIXS_B3_BOE_HOTPATH
    GroupList groups() ONIXS_B3_BOE_NOTHROW
    {
        assert(header_);
 
        void* list = advanceByBytes<void>(body(), blockLength());
 
        const MessageSize listSize = size_ - MessageHeader::Size - header_->blockLength();
 
        return GroupList(list, listSize, header_->version());
    }

    ONIXS_B3_BOE_HOTPATH
    GroupList groups() const ONIXS_B3_BOE_NOTHROW
    {
        assert(header_);
 
        const void* list = advanceByBytes(block(), blockLength());
 
        const MessageSize listSize = size_ - MessageHeader::Size - header_->blockLength();
 
        return GroupList(const_cast<void*>(list), listSize, header_->version());
    }

    template<typename Group>
    ONIXS_B3_BOE_HOTPATH
    void initGroup(Group& group, typename Group::EntrySize entrySize) ONIXS_B3_BOE_NOTHROW
    {
        assert(group.valid());
        group.init(entrySize);
    }

    template<typename Group>
    ONIXS_B3_BOE_HOTPATH
    void setupGroup(Group& group, typename Group::Size entryCount, const void* messageTail)
    {
        assert(messageTail);
        assert(group.valid());
        group.setup(entryCount, messageTail, blockEnd());
    }

    template<typename Group>
    ONIXS_B3_BOE_HOTPATH
    void constructGroup(Group& group, typename Group::Size entryCount, const void* messageTail)
    {
        assert(messageTail);
        assert(group.valid());
        group.construct(entryCount, messageTail, blockEnd());
    }

    template<typename DATA>
    void setVarDataField(DATA& data, StrRef value, const void* oldMessageTail)
    {
        assert(oldMessageTail);
 
        const ptrdiff_t lengthChange = static_cast<ptrdiff_t>(value.length() - data.length());
 
        const void* const newMessageTail = advanceByBytes(oldMessageTail, lengthChange);
 
        if ONIXS_B3_BOE_UNLIKELY(byteDistance(blockEnd(), newMessageTail) < 0)
            throwNotEnoughSpace();
 
        const void* const oldEndOfData = advanceByBytes(data.varData().data(), data.varData().size());
 
        void* const newEndOfData = toOpaquePtr(advanceByBytes(&data, value.length() + DATA::Size));
 
        std::memmove(newEndOfData, oldEndOfData, byteDistance(oldMessageTail, oldEndOfData));
 
        data.varData(value);
    }

    typedef SbeVariableLengthFieldList<MessageSize> VariableLengthFieldList;

    ONIXS_B3_BOE_HOTPATH
    VariableLengthFieldList variableLengthFields() ONIXS_B3_BOE_NOTHROW
    {
        assert(header_);
 
        void* list = advanceByBytes<void>(body(), blockLength());
 
        const MessageSize listSize = size_ - MessageHeader::Size - header_->blockLength();
 
        return VariableLengthFieldList(list, listSize, header_->version());
    }

    ONIXS_B3_BOE_HOTPATH
    VariableLengthFieldList variableLengthFields() const ONIXS_B3_BOE_NOTHROW
    {
        assert(header_);
 
        const void* list = advanceByBytes(block(), blockLength());
 
        const MessageSize listSize = size_ - MessageHeader::Size - header_->blockLength();
 
        return VariableLengthFieldList(const_cast<void*>(list), listSize, header_->version());
    }
 
    ONIXS_B3_BOE_HOTPATH
    void init(
        MessageHeader::TemplateId value,
        MessageHeader::BlockLength minimalBlockLength,
        MessageHeader::BlockLength blockLength,
        SchemaId id) ONIXS_B3_BOE_NOTHROW
    {
        assert(header_);
        assert(blockLength >= minimalBlockLength);
 
        header_->setTemplateId(value);
        header_->setBlockLength(blockLength);
        header_->setSchemaId(id);
 
        zeroPaddingBytes(minimalBlockLength);
    }
 
    ONIXS_B3_BOE_HOTPATH
    MessageSize calculateBinarySize(const void* tail) const ONIXS_B3_BOE_NOTHROW
    {
        assert(tail);
 
        const ptrdiff_t distance = byteDistance(tail, binary());
 
        assert(distance > 0);
 
        assert(distance <= (std::numeric_limits<MessageSize>::max)());
 
        const MessageSize size = static_cast<MessageSize>(distance);
 
        assert(size <= size_);
 
        return size;
    }

    template<class Callable, class Owner>
    void setVariableLengthField(Callable callable, StrRef value, Owner& owner)
    {
        setVarDataField(callable(owner), value, owner.tail());
    }

    template<class Callable, class Owner>
    void setVariableLengthField(Callable callable, StrRef value, SchemaVersion since, Owner& owner)
    {
        if ONIXS_B3_BOE_UNLIKELY(since > version())
            throwDisallowedField();
 
        setVariableLengthField(callable, value, owner);
    }

    template<class Callable, class Owner>
    StrRef getVariableLengthField(Callable callable, const Owner& owner) const ONIXS_B3_BOE_NOTHROW
    {
        ONIXS_B3_BOE_CHECK_NOTHROW(callable(owner));
        return callable(owner).varData();
    }

    template<class Callable, class Owner>
    StrRef getVariableLengthField(Callable callable, SchemaVersion since, Owner& owner) const ONIXS_B3_BOE_NOTHROW
    {
        if ONIXS_B3_BOE_UNLIKELY(since > version())
            return StrRef();
 
        return getVariableLengthField(callable, owner);
    }

    template<class Callable, class Owner>
    void setVariableLengthFieldToNull(Callable callable, Owner& owner) ONIXS_B3_BOE_NOTHROW
    {
        ONIXS_B3_BOE_CHECK_NOTHROW(callable(owner));
        callable(owner).length(0);
    }

    template<class Group, class Callable, class Owner>
    void resetGroup(Callable callable, Owner& owner) ONIXS_B3_BOE_NOTHROW
    {
        const typename Group::EntrySize entrySize = Group::Entry::blockLength(version());
 
        Group grp = callable(owner);
 
        initGroup(grp, entrySize);
    }

    template<class Callable, class Owner>
    void setVariableLengthFieldToNull(Callable callable, SchemaVersion since, Owner& owner) ONIXS_B3_BOE_NOTHROW
    {
        if ONIXS_B3_BOE_UNLIKELY(since > version())
            return;
 
        setVariableLengthFieldToNull(callable, owner);
    }

    template<class Group, class Callable, class Owner>
    void resetGroup(Callable callable, SchemaVersion since, Owner& owner)
    {
        if ONIXS_B3_BOE_UNLIKELY(since > version())
            return;
 
        resetGroup<Group>(callable, owner);
    }

    template<class Group, class Callable, class Owner>
    Group getGroup(Callable callable, Owner& owner) const ONIXS_B3_BOE_NOTHROW
    {
        ONIXS_B3_BOE_CHECK_NOTHROW(callable(owner));
        return callable(owner);
    }

    template<class Group, class Callable, class Owner>
    Group getGroup(Callable callable, SchemaVersion since, Owner& owner) const ONIXS_B3_BOE_NOTHROW
    {
        if ONIXS_B3_BOE_UNLIKELY(since > version())
            return Group();
 
        return getGroup<Group>(callable, owner);
    }

    template<class Group, class Callable, class Owner>
    Group constructGroup(Callable callable, typename Group::Size length, SchemaVersion since, Owner& owner)
    {
        if ONIXS_B3_BOE_UNLIKELY(since > version())
            return Group();
 
        return constructGroup<Group>(callable, length, owner);
    }

    template<class Group, class Callable, class Owner>
    Group constructGroup(Callable callable, typename Group::Size length, Owner& owner)
    {
        Group group = callable(owner);
 
        constructGroup(group, length, owner.tail());
 
        return group;
    }

    template<class Group, class Callable, class Owner>
    Group setupGroup(Callable callable, typename Group::Size length, SchemaVersion since, Owner& owner)
    {
        if ONIXS_B3_BOE_UNLIKELY(since > version())
            return Group();
 
        return setupGroup<Group>(callable, length, owner);
    }

    template<class Group, class Callable, class Owner>
    Group setupGroup(Callable callable, typename Group::Size length, Owner& owner)
    {
        Group group = callable(owner);
 
        setupGroup(group, length, owner.tail());
 
        return group;
    }

    ONIXS_B3_BOE_LTWT_EXPORTED
    ONIXS_B3_BOE_NODISCARD
    ONIXS_B3_BOE_CONSTEXPR
    static MessageSize getMaxMessageSize() ONIXS_B3_BOE_NOTHROW
    {
        return
            MaxB3BOEMessageSize;
    }
 
private:
    MessageHeader* header_;
    MessageSize size_;
};
 
ONIXS_B3_BOE_MESSAGING_NAMESPACE_END