Packet.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 <cassert>
#include <stdexcept>
 
#include <OnixS/CME/MDH/messaging/Time.h>
#include <OnixS/CME/MDH/messaging/Integral.h>
#include <OnixS/CME/MDH/messaging/SbeMessage.h>
 
#include <OnixS/CME/MDH/PacketTraits.h>
 
ONIXS_CMEMDH_NAMESPACE_BEGIN
ONIXS_CMEMDH_DATA_PACKING_BEGIN(1)
 
ONIXS_CMEMDH_LTWT_CLASS_DECL(NetFeed);
ONIXS_CMEMDH_LTWT_CLASS_DECL(Packet);

ONIXS_CMEMDH_EXPORTED
void throwBadMessage(const Packet* packet);

class ONIXS_CMEMDH_LTWT BinaryMessageIterator
{
public:
    // Identifies iterator category.
    typedef std::forward_iterator_tag iterator_category;

    typedef ptrdiff_t difference_type;

    typedef const Messaging::SbeMessage value_type;

    typedef value_type* pointer;

    typedef value_type& reference;

    BinaryMessageIterator(const void* dataBegin, const void* dataEnd, const Packet* packet)
        : header_(static_cast<const Header*>(dataBegin))
        , end_(dataEnd)
        , packet_(packet)
    {
        assert(dataBegin <= dataEnd);
 
        validate();
    }

    ONIXS_CMEMDH_FORCEINLINE
    value_type message() const
    {
        assert(header_ != end_);
 
        return Messaging::constructFromImmutableBlock<value_type>(header_ + 1, header_->messageSize() - sizeof(Header));
    }

    ONIXS_CMEMDH_FORCEINLINE
    value_type operator*() const
    {
        return message();
    }

    BinaryMessageIterator& operator++()
    {
        header_ = Messaging::advanceByBytes(header_, header_->messageSize());
 
        validate();
 
        return *this;
    }

    bool operator==(const BinaryMessageIterator& other) const
    {
        return header_ == other.header_;
    }

    bool operator!=(const BinaryMessageIterator& other) const
    {
        return header_ != other.header_;
    }
 
private:
    using Header = MessagePrefix;
 
    const Header* header_;
    const void* end_;
    const Packet* packet_;
 
    void validate() const
    {
        const size_t availableSize = Messaging::byteDistance(end_, header_);
 
        if ONIXS_CMEMDH_LIKELY(availableSize != 0)
            if ONIXS_CMEMDH_UNLIKELY(availableSize < sizeof(Header) || availableSize < header_->messageSize())
                throwBadMessage(packet_);
    }
};

class ONIXS_CMEMDH_LTWT BinaryMessages
{
public:
    BinaryMessages(const void* messagesBegin, const void* messagesEnd, const Packet* packet = nullptr)
        : begin_(messagesBegin)
        , end_(messagesEnd)
        , packet_(packet)
    {
    }

    ONIXS_CMEMDH_FORCEINLINE
    BinaryMessageIterator begin() const
    {
        return BinaryMessageIterator(begin_, end_, packet_);
    }

    ONIXS_CMEMDH_FORCEINLINE
    BinaryMessageIterator end() const
    {
        return BinaryMessageIterator(end_, end_, packet_);
    }
 
private:
    // Memory block keeping messages.
    const void* begin_;
    const void* end_;
    const Packet* packet_;
};

ONIXS_CMEMDH_EXPORTED
ONIXS_CMEMDH_COLDPATH
void throwBadPacket(PacketSize packetSize, PacketSize minimalSize, const void* data);

struct ONIXS_CMEMDH_LTWT NoVerify {};

class ONIXS_CMEMDH_LTWT Packet
{
public:
    using Header = PacketHeader;

    Packet() noexcept
        : header_(nullptr)
        , size_(0)
    {
    }

    Packet(const void* data, PacketSize size)
        : header_(static_cast<const Header*>(data))
        , size_(size)
    {
        assert(nullptr != header_);
        assert(0 != size_);
 
        const PacketSize headerSize = sizeof(Header);
 
        if ONIXS_CMEMDH_UNLIKELY(size < headerSize)
            throwBadPacket(size, headerSize, data);
    }

    Packet(const void* data, PacketSize size, const NoVerify&) noexcept
        : header_(static_cast<const Header*>(data))
        , size_(size)
    {
    }

    Packet(const Packet& other) noexcept
        : header_(other.header_)
        , size_(other.size_)
    {
    }

    ~Packet() = default;

    ONIXS_CMEMDH_FORCEINLINE
    operator bool() const noexcept
    {
        return 0 != size_;
    }

    ONIXS_CMEMDH_FORCEINLINE
    const void* data() const noexcept
    {
        assert(nullptr != header_);
 
        return header_;
    }

    ONIXS_CMEMDH_FORCEINLINE
    const Header* header() const noexcept
    {
        assert(nullptr != header_);
 
        return header_;
    }

    ONIXS_CMEMDH_FORCEINLINE
    PacketSize size() const noexcept
    {
        return size_;
    }

    ONIXS_CMEMDH_FORCEINLINE
    SequenceNumber seqNumber() const noexcept
    {
        assert(nullptr != header_);
 
        return header_->seqNumber();
    }

    ONIXS_CMEMDH_FORCEINLINE
    Messaging::Timestamp sendingTime() const noexcept
    {
        assert(nullptr != header_);
 
        return header_->sendingTime();
    }

    ONIXS_CMEMDH_FORCEINLINE
    BinaryMessages messages() const
    {
        assert(nullptr != header_);
 
        return BinaryMessages(header_ + 1, Messaging::advanceByBytes(header_, size_), this);
    }

    void reset() noexcept
    {
        header_ = nullptr;
        size_ = 0;
    }

    void reset(const void* data, PacketSize size)
    {
        const PacketSize headerSize = sizeof(Header);
 
        if ONIXS_CMEMDH_UNLIKELY(!data || size < headerSize)
            throwBadPacket(size, headerSize, data);
 
        header_ = static_cast<const Header*>(data);
        size_ = size;
    }

    ONIXS_CMEMDH_FORCEINLINE
    void reset(const void* data, PacketSize size, const NoVerify&) noexcept
    {
        header_ = static_cast<const Header*>(data);
 
        size_ = size;
    }

    Packet& operator=(const Packet& other) noexcept
    {
        header_ = other.header_;
        size_ = other.size_;
 
        return *this;
    }
 
private:
    const Header* header_;
    PacketSize size_;
};
 
ONIXS_CMEMDH_EXPORTED
void toStr(std::string& str, const Packet& packet);
 
inline std::string toStr(const Packet& packet)
{
    std::string str;
    toStr(str, packet);
    return str;
}
 
class ONIXS_CMEMDH_LTWT NetPacket : public Packet
{
public:
    NetPacket() noexcept
        : source_(nullptr)
    {
    }

    NetPacket(const void* data, PacketSize size)
        : Packet(data, size)
        , source_(nullptr)
    {
    }

    NetPacket(const NetPacket& other)
        : Packet(static_cast<const Packet&>(other))
        , receiveTime_(other.receiveTime_)
        , source_(other.source_)
    {
    }

    ~NetPacket() = default;

    ONIXS_CMEMDH_FORCEINLINE
    const NetFeed& source() const noexcept
    {
        assert(nullptr != source_);
 
        return *source_;
    }

    ONIXS_CMEMDH_FORCEINLINE
    void source(const NetFeed& source) noexcept
    {
        source_ = &source;
    }

    ONIXS_CMEMDH_FORCEINLINE
    const Messaging::Timestamp& receiveTime() const noexcept
    {
        return receiveTime_;
    }

    ONIXS_CMEMDH_FORCEINLINE
    void receiveTime(const Messaging::Timestamp& receiveTime) noexcept
    {
        receiveTime_ = receiveTime;
    }

    void reset()
    {
        Packet::reset();
 
        receiveTime_ = Messaging::Timestamp();
 
        source_ = nullptr;
    }

    NetPacket& operator=(const NetPacket& other)
    {
        static_cast<Packet&>(*this) = static_cast<const Packet&>(other);
 
        receiveTime_ = other.receiveTime_;
 
        source_ = other.source_;
 
        return *this;
    }
 
private:
    Messaging::Timestamp receiveTime_;
    const NetFeed* source_;
};

typedef NetPacket PacketArgs;
 
ONIXS_CMEMDH_DATA_PACKING_END
ONIXS_CMEMDH_NAMESPACE_END