NetworkMessage Class Reference

Public Member Functions
	NetworkMessage () noexcept
	NetworkMessage (const void *data, size_t size, SbeMessage::NoCheck) noexcept
	NetworkMessage (const void *data, size_t size)
const SimpleOpenFramingHeader *	header () const noexcept
const void *	data () const noexcept
MessageSize	size () const noexcept
void	clear () noexcept
bool	valid () const noexcept
SbeMessage	message () const noexcept
std::string	toString () const

Detailed Description

Definition at line 30 of file NetworkMessage.h.

Constructor & Destructor Documentation

NetworkMessage() [1/3]

NetworkMessage ( )

inlinenoexcept

Constructs an empty instance.

Definition at line 34 of file NetworkMessage.h.

        : data_(nullptr)
        , size_(0)
    {}

NetworkMessage() [2/3]

NetworkMessage ( const void * data, size_t size, SbeMessage::NoCheck  )

inlinenoexcept

Constructs NetworkMessage from a data block. Performs no checks.

Definition at line 40 of file NetworkMessage.h.

        : data_(nullptr)
        , size_(0)
    {
        assert(size >= sizeof(SimpleOpenFramingHeader));
 
        const SimpleOpenFramingHeader* const header = reinterpret_cast<const SimpleOpenFramingHeader*>(data);
 
        assert(header->encoding() == SbeEncodingType);
        assert(header->size() <= size);
 
#ifndef NDEBUG
        SbeMessage(toByteBlock(toMutable(data)) + sizeof(SimpleOpenFramingHeader), header->size() - sizeof(SimpleOpenFramingHeader));
#endif
 
        data_ = data;
        size_ = header->size();
    }

NetworkMessage() [3/3]

NetworkMessage ( const void * data, size_t size )

inline

Constructs NetworkMessage from a data block.

Definition at line 60 of file NetworkMessage.h.

        : data_(nullptr)
        , size_(0)
    {
         if ONIXS_ICEBOE_UNLIKELY(size < sizeof(SimpleOpenFramingHeader))
             throwBinaryBlockIsTooSmall(static_cast<MessageSize>(size), sizeof(SimpleOpenFramingHeader), "SimpleOpenFramingHeader");
 
        const SimpleOpenFramingHeader* const header = reinterpret_cast<const SimpleOpenFramingHeader*>(data);
 
        if ONIXS_ICEBOE_UNLIKELY(header->encoding() != SbeEncodingType)
            throwIncorrectEncoding(header->encoding(), data, static_cast<MessageSize>(size));
 
        if ONIXS_ICEBOE_UNLIKELY(header->size() > size)
            throwNetPacketIsTooSmall(static_cast<MessageSize>(size), header->size());
 
        SbeMessage(toByteBlock(toMutable(data)) + sizeof(SimpleOpenFramingHeader), header->size() - sizeof(SimpleOpenFramingHeader));
 
        data_ = data;
        size_ = header->size();
    }

Member Function Documentation

clear()

void clear ( )

inlinenoexcept

Blank the instance.

Definition at line 100 of file NetworkMessage.h.

    {
        *this = NetworkMessage();
        assert(!valid());
    }

data()

const void * data ( ) const

inlinenoexcept

Definition at line 88 of file NetworkMessage.h.

    {
        return data_;
    }

header()

const SimpleOpenFramingHeader * header ( ) const

inlinenoexcept

Definition at line 82 of file NetworkMessage.h.

    {
        return reinterpret_cast<const SimpleOpenFramingHeader*>(data_);
    }

message()

SbeMessage message ( ) const

inlinenoexcept

Retrieves the underlying SBE message.

Definition at line 115 of file NetworkMessage.h.

    {
        assert(valid());
 
#ifndef NDEBUG
        SbeMessage(toByteBlock(toMutable(data_)) + sizeof(SimpleOpenFramingHeader), size_ - sizeof(SimpleOpenFramingHeader));
#endif
 
        return SbeMessage(
            toByteBlock(toMutable(data_)) + sizeof(SimpleOpenFramingHeader),
            size_ - sizeof(SimpleOpenFramingHeader), SbeMessage::NoCheck());
    }

size()

MessageSize size ( ) const

inlinenoexcept

Definition at line 94 of file NetworkMessage.h.

    {
        return size_;
    }

toString()

std::string toString ( ) const

inline

Serializes into a string.

Definition at line 148 of file NetworkMessage.h.

{
    return toStr(*this);
}

valid()

bool valid ( ) const

inlinenoexcept

Returns

true if the instance refers to a valid packet, otherwise - false.

Definition at line 108 of file NetworkMessage.h.

    {
        return (nullptr != data_);
    }