SbeMessage Class Reference

Classes
struct	NoCheck
struct	NoFieldsInit
struct	NoInit

Public Types
typedef MessageSize	EncodedLength
typedef MessageSize	BlockLength

Public Member Functions
	SbeMessage () noexcept
	SbeMessage (void *data, MessageSize size, SchemaVersion version)
	SbeMessage (void *data, MessageSize size)
	SbeMessage (void *data, MessageSize size, NoCheck) noexcept
void	clear () noexcept
bool	valid () const noexcept
	operator bool () const noexcept
MessageTemplateId	templateId () const noexcept
SchemaVersion	version () const noexcept
SchemaId	schemaId () const noexcept
SequenceId	sequenceId () const noexcept
SbeMessage &	sequenceId (SequenceId value) noexcept
Timestamp	sendTime () const noexcept
SbeMessage &	sendTime (Timestamp value) noexcept
HeaderFlags	headerFlags () const noexcept
SbeMessage &	headerFlags (HeaderFlags value) noexcept
const void *	binary () const noexcept
void *	binary () noexcept
const void *	blockEnd () noexcept
const void *	blockEnd () const noexcept
MessageSize	bufferSize () const noexcept
void *	body () noexcept
BlockLength	blockLength () const noexcept
const void *	block () const noexcept
void *	block () noexcept
Public Member Functions inherited from SbeFields< Messaging::SbeMessage, MessageSize >
ONIXS_ICEBOE_FORCEINLINE Messaging::SbeMessage &	container () noexcept
void	zeroPaddingBytes (MessageSize offset) noexcept
ONIXS_ICEBOE_FORCEINLINE void	setOrdinary (MessageSize offset, FieldValue value) noexcept
ONIXS_ICEBOE_FORCEINLINE void	setEnumeration (MessageSize offset, Enumeration value) noexcept
ONIXS_ICEBOE_FORCEINLINE void	setFixedStr (MessageSize offset, StrRef value) noexcept

Protected Types
typedef SbeGroupList< MessageSize >	GroupList
typedef SbeVariableLengthFieldList< MessageSize >	VariableLengthFieldList

Protected Member Functions
SbeMessage &	version (SchemaVersion version) noexcept
GroupList	groups () noexcept
GroupList	groups () const noexcept
template<typename Group>
void	initGroup (Group &group, typename Group::EntrySize entrySize) noexcept
template<typename Group>
void	setupGroup (Group &group, typename Group::Size entryCount, const void *messageTail)
template<typename Group>
void	constructGroup (Group &group, typename Group::Size entryCount, const void *messageTail)
template<typename DATA>
void	setVarDataField (DATA &data, StrRef value, const void *oldMessageTail)
VariableLengthFieldList	variableLengthFields () noexcept
VariableLengthFieldList	variableLengthFields () const noexcept
void	init (MessageHeader::TemplateId value, MessageHeader::BlockLength minimalBlockLength, MessageHeader::BlockLength blockLength, SchemaId id) noexcept
MessageSize	calculateBinarySize (const void *tail) const noexcept
template<class Callable, class Owner>
void	setVariableLengthField (Callable callable, StrRef value, Owner &owner)
template<class Callable, class Owner>
void	setVariableLengthField (Callable callable, StrRef value, SchemaVersion since, Owner &owner)
template<class Callable, class Owner>
StrRef	getVariableLengthField (Callable callable, const Owner &owner) const noexcept
template<class Callable, class Owner>
StrRef	getVariableLengthField (Callable callable, SchemaVersion since, Owner &owner) const noexcept
template<class Callable, class Owner>
void	setVariableLengthFieldToNull (Callable callable, Owner &owner) noexcept
template<class Group, class Callable, class Owner>
void	resetGroup (Callable callable, Owner &owner) noexcept
template<class Callable, class Owner>
void	setVariableLengthFieldToNull (Callable callable, SchemaVersion since, Owner &owner) noexcept
template<class Group, class Callable, class Owner>
void	resetGroup (Callable callable, SchemaVersion since, Owner &owner)
template<class Group, class Callable, class Owner>
ONIXS_ICEBOE_FORCEINLINE Group	getGroup (Callable callable, Owner &owner) const noexcept
template<class Group, class Callable, class Owner>
ONIXS_ICEBOE_FORCEINLINE Group	getGroup (Callable callable, SchemaVersion since, Owner &owner) const noexcept
template<class Group, class Callable, class Owner>
ONIXS_ICEBOE_FORCEINLINE Group	constructGroup (Callable callable, typename Group::Size length, SchemaVersion since, Owner &owner)
template<class Group, class Callable, class Owner>
ONIXS_ICEBOE_FORCEINLINE Group	constructGroup (Callable callable, typename Group::Size length, Owner &owner)
template<class Group, class Callable, class Owner>
Group	setupGroup (Callable callable, typename Group::Size length, SchemaVersion since, Owner &owner)
template<class Group, class Callable, class Owner>
Group	setupGroup (Callable callable, typename Group::Size length, Owner &owner)
Protected Member Functions inherited from SbeFields< Messaging::SbeMessage, MessageSize >
	SbeFields ()=default
	~SbeFields ()=default
Protected Member Functions inherited from BinaryBlock< Messaging::SbeMessage, MessageSize >
	BinaryBlock ()=default
	~BinaryBlock ()=default
ONIXS_ICEBOE_FORCEINLINE Value	ordinary (MessageSize offset) const noexcept
ONIXS_ICEBOE_FORCEINLINE Enumeration	enumeration (MessageSize offset) const noexcept
ONIXS_ICEBOE_FORCEINLINE StrRef	fixedStr (MessageSize offset) const noexcept
ONIXS_ICEBOE_FORCEINLINE Value	decimal (MessageSize offset) const noexcept
ONIXS_ICEBOE_FORCEINLINE std::enable_if<!isComposite< typenameNullValue::Value >::value, SbeOptionalConverted< decltype(std::declval< Callable >()(std::declval< typenameArgType< Callable >::type >()))> >::type	convertible (MessageSize offset, OptionalTag) const noexcept(noexcept(Callable::Nothrow))
Protected Member Functions inherited from BinaryBlockBase
	~BinaryBlockBase ()=default

Static Protected Member Functions
static constexpr MessageSize	getMaxMessageSize () noexcept

Detailed Description

Definition at line 1172 of file SbeMessage.h.

Member Typedef Documentation

BlockLength

typedef MessageSize BlockLength

Length of the message body representing a block of fixed-length fields.

Definition at line 1184 of file SbeMessage.h.

EncodedLength

typedef MessageSize EncodedLength

Length of the message binary data.

Definition at line 1181 of file SbeMessage.h.

GroupList

typedef SbeGroupList<MessageSize> GroupList

protected

Binary group list instantiation.

Definition at line 1409 of file SbeMessage.h.

VariableLengthFieldList

typedef SbeVariableLengthFieldList<MessageSize> VariableLengthFieldList

protected

Binary group list instantiation.

Definition at line 1499 of file SbeMessage.h.

Constructor & Destructor Documentation

SbeMessage() [1/4]

SbeMessage ( )

inlinenoexcept

Initializes a blank instance.

Definition at line 1187 of file SbeMessage.h.

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

SbeMessage() [2/4]

SbeMessage ( void * data, MessageSize size, SchemaVersion version )

inline

Initializes the instance over the given memory block.

Definition at line 1195 of file SbeMessage.h.

        : header_(static_cast<MessageHeader*>(data))
        , size_(size)
    {
        assert(data);
        assert(size <= MaxSbeMessageSize);
 
        if ONIXS_ICEBOE_UNLIKELY(size < MessageHeader::Size)
            throwBinaryBlockIsTooSmall(size, MessageHeader::Size);
 
        this->version(version);
    }

SbeMessage() [3/4]

SbeMessage ( void * data, MessageSize size )

inline

Initializes the instance over the given memory block.

Definition at line 1210 of file SbeMessage.h.

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

SbeMessage() [4/4]

SbeMessage ( void * data, MessageSize size, NoCheck  )

inlinenoexcept

Initializes the instance over the given memory block.

Note

Performs no check of the data consistency

Definition at line 1229 of file SbeMessage.h.

        : header_(static_cast<MessageHeader*>(data))
        , size_(size)
    {
        assert(data);
        assert(size <= MaxSbeMessageSize);
 
        assert(size >= MessageHeader::Size);
        assert(size >= MessageHeader::Size + header_->blockLength());
    }

Member Function Documentation

binary() [1/2]

const void * binary ( ) const

inlinenoexcept

Returns

SBE-encoded message content.

Definition at line 1338 of file SbeMessage.h.

    {
        assert(valid());
 
        return header_;
    }

binary() [2/2]

void * binary ( )

inlinenoexcept

Returns

SBE-encoded message content.

Definition at line 1346 of file SbeMessage.h.

    {
        assert(valid());
 
        return header_;
    }

block() [1/2]

const void * block ( ) const

inlinenoexcept

Returns

the beginning of the message body.

Definition at line 1392 of file SbeMessage.h.

    {
        assert(valid());
 
        return advanceByBytes(header_, MessageHeader::Size);
    }

block() [2/2]

void * block ( )

inlinenoexcept

Returns

the beginning of the message body.

Definition at line 1400 of file SbeMessage.h.

    {
        assert(valid());
 
        return advanceByBytes(header_, MessageHeader::Size);
    }

blockEnd() [1/2]

const void * blockEnd ( ) const

inlinenoexcept

Definition at line 1362 of file SbeMessage.h.

    {
        assert(valid());
 
        return advanceByBytes(header_, size_);
    }

blockEnd() [2/2]

const void * blockEnd ( )

inlinenoexcept

Definition at line 1354 of file SbeMessage.h.

    {
        assert(valid());
 
        return advanceByBytes(header_, size_);
    }

blockLength()

BlockLength blockLength ( ) const

inlinenoexcept

Returns

the size of the message body in bytes.

Definition at line 1384 of file SbeMessage.h.

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

body()

void * body ( )

inlinenoexcept

Returns

the beginning of the message body.

Definition at line 1376 of file SbeMessage.h.

    {
        assert(valid());
 
        return advanceByBytes(header_, MessageHeader::Size);
    }

bufferSize()

MessageSize bufferSize ( ) const

inlinenoexcept

Returns

the size of the message buffer.

Definition at line 1370 of file SbeMessage.h.

    {
        return size_;
    }

calculateBinarySize()

MessageSize calculateBinarySize ( const void * tail ) const

inlineprotectednoexcept

Definition at line 1548 of file SbeMessage.h.

    {
        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;
    }

clear()

void clear ( )

inlinenoexcept

Blank the instance.

Definition at line 1241 of file SbeMessage.h.

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

constructGroup() [1/3]

template<class Group, class Callable, class Owner>

ONIXS_ICEBOE_FORCEINLINE Group constructGroup ( Callable callable, typename Group::Size length, Owner & owner )

inlineprotected

Creates a repeating group with the given number of entries, sets all optional fields of the group entries to null.

Definition at line 1673 of file SbeMessage.h.

    {
        Group group = callable(owner);
 
        constructGroup(group, length, owner.tail());
 
        return group;
    }

constructGroup() [2/3]

template<class Group, class Callable, class Owner>

ONIXS_ICEBOE_FORCEINLINE Group constructGroup ( Callable callable, typename Group::Size length, SchemaVersion since, Owner & owner )

inlineprotected

Creates a repeating group with the given number of entries, sets all optional fields of the group entries to null.

Definition at line 1662 of file SbeMessage.h.

    {
        if ONIXS_ICEBOE_UNLIKELY(since > version())
            return Group();
 
        return constructGroup<Group>(callable, length, owner);
    }

constructGroup() [3/3]

template<typename Group>

void constructGroup ( Group & group, typename Group::Size entryCount, const void * messageTail )

inlineprotected

Initializes the group header, sets all optional fields to null.

Definition at line 1469 of file SbeMessage.h.

    {
        assert(messageTail);
        assert(group.valid());
        group.construct(entryCount, messageTail, blockEnd());
    }

getGroup() [1/2]

template<class Group, class Callable, class Owner>

ONIXS_ICEBOE_FORCEINLINE Group getGroup ( Callable callable, Owner & owner ) const

inlineprotectednoexcept

Returns

the repeating group.

Definition at line 1642 of file SbeMessage.h.

    {
        ONIXS_ICEBOE_CHECK_NOTHROW(callable(owner));
        return callable(owner);
    }

getGroup() [2/2]

template<class Group, class Callable, class Owner>

ONIXS_ICEBOE_FORCEINLINE Group getGroup ( Callable callable, SchemaVersion since, Owner & owner ) const

inlineprotectednoexcept

Returns

the repeating group.

Definition at line 1651 of file SbeMessage.h.

    {
        if ONIXS_ICEBOE_UNLIKELY(since > version())
            return Group();
 
        return getGroup<Group>(callable, owner);
    }

getMaxMessageSize()

constexpr MessageSize getMaxMessageSize ( )

inlinestaticconstexprprotectednoexcept

Maximal message size.

Definition at line 1707 of file SbeMessage.h.

    {
        return
            MaxSbeMessageSize;
    }

getVariableLengthField() [1/2]

template<class Callable, class Owner>

StrRef getVariableLengthField ( Callable callable, const Owner & owner ) const

inlineprotectednoexcept

Returns

the value of the variable length field.

Definition at line 1584 of file SbeMessage.h.

    {
        ONIXS_ICEBOE_CHECK_NOTHROW(callable(owner));
        return callable(owner).varData();
    }

getVariableLengthField() [2/2]

template<class Callable, class Owner>

StrRef getVariableLengthField ( Callable callable, SchemaVersion since, Owner & owner ) const

inlineprotectednoexcept

Returns

the value of the variable length field.

Definition at line 1592 of file SbeMessage.h.

    {
        if ONIXS_ICEBOE_UNLIKELY(since > version())
            return StrRef();
 
        return getVariableLengthField(callable, owner);
    }

groups() [1/2]

GroupList groups ( ) const

inlineprotectednoexcept

Returns

the list of repeating groups

Definition at line 1436 of file SbeMessage.h.

    {
        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());
    }

groups() [2/2]

GroupList groups ( )

inlineprotectednoexcept

Returns

the list of repeating groups

Definition at line 1423 of file SbeMessage.h.

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

headerFlags() [1/2]

HeaderFlags headerFlags ( ) const

inlinenoexcept

Returns

Send Time.

Definition at line 1320 of file SbeMessage.h.

    {
        assert(valid());
 
        return header_->headerFlags();
    }

headerFlags() [2/2]

SbeMessage & headerFlags ( HeaderFlags value )

inlinenoexcept

Sets Send Time.

Definition at line 1328 of file SbeMessage.h.

    {
        assert(valid());
 
        header_->headerFlags(value);
 
        return *this;
    }

init()

void init ( MessageHeader::TemplateId value, MessageHeader::BlockLength minimalBlockLength, MessageHeader::BlockLength blockLength, SchemaId id )

inlineprotectednoexcept

Definition at line 1528 of file SbeMessage.h.

    {
        assert(header_);
        assert(blockLength >= minimalBlockLength);
 
        header_->templateId(value);
        header_->blockLength(blockLength);
        header_->schemaId(id);
        header_->sequenceId(0);
        header_->sendTime(Timestamp{});
        header_->headerFlags(HeaderFlags::None);
 
        zeroPaddingBytes(minimalBlockLength);
    }

initGroup()

template<typename Group>

void initGroup ( Group & group, typename Group::EntrySize entrySize )

inlineprotectednoexcept

Resets the group to the initial state.

Definition at line 1450 of file SbeMessage.h.

    {
        assert(group.valid());
        group.init(entrySize);
    }

operator bool()

operator bool ( ) const

inlineexplicitnoexcept

Definition at line 1253 of file SbeMessage.h.

    {
        return valid();
    }

resetGroup() [1/2]

template<class Group, class Callable, class Owner>

void resetGroup ( Callable callable, Owner & owner )

inlineprotectednoexcept

Sets the group to the initial state.

Definition at line 1610 of file SbeMessage.h.

    {
        const typename Group::EntrySize entrySize = Group::Entry::blockLength(version());
 
        Group grp = callable(owner);
 
        initGroup(grp, entrySize);
    }

resetGroup() [2/2]

template<class Group, class Callable, class Owner>

void resetGroup ( Callable callable, SchemaVersion since, Owner & owner )

inlineprotected

Resets the repeating group.

Definition at line 1631 of file SbeMessage.h.

    {
        if ONIXS_ICEBOE_UNLIKELY(since > version())
            return;
 
        resetGroup<Group>(callable, owner);
    }

schemaId()

SchemaId schemaId ( ) const

inlinenoexcept

Returns

SBE Schema ID.

Definition at line 1275 of file SbeMessage.h.

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

sendTime() [1/2]

Timestamp sendTime ( ) const

inlinenoexcept

Returns

Send Time.

Definition at line 1301 of file SbeMessage.h.

    {
        assert(valid());
 
        return header_->sendTime();
    }

sendTime() [2/2]

SbeMessage & sendTime ( Timestamp value )

inlinenoexcept

Sets Send Time.

Definition at line 1310 of file SbeMessage.h.

    {
        assert(valid());
 
        header_->sendTime(value);
 
        return *this;
    }

sequenceId() [1/2]

SequenceId sequenceId ( ) const

inlinenoexcept

Returns

Sequence ID.

Definition at line 1283 of file SbeMessage.h.

    {
        assert(valid());
 
        return header_->sequenceId();
    }

sequenceId() [2/2]

SbeMessage & sequenceId ( SequenceId value )

inlinenoexcept

Sets Sequence ID.

Definition at line 1291 of file SbeMessage.h.

    {
        assert(valid());
 
        header_->sequenceId(value);
 
        return *this;
    }

setupGroup() [1/3]

template<class Group, class Callable, class Owner>

Group setupGroup ( Callable callable, typename Group::Size length, Owner & owner )

inlineprotected

Setups the repeating group with the given number of entries.

Definition at line 1694 of file SbeMessage.h.

    {
        Group group = callable(owner);
 
        setupGroup(group, length, owner.tail());
 
        return group;
    }

setupGroup() [2/3]

template<class Group, class Callable, class Owner>

Group setupGroup ( Callable callable, typename Group::Size length, SchemaVersion since, Owner & owner )

inlineprotected

Setups the repeating group with the given number of entries.

Definition at line 1684 of file SbeMessage.h.

    {
        if ONIXS_ICEBOE_UNLIKELY(since > version())
            return Group();
 
        return setupGroup<Group>(callable, length, owner);
    }

setupGroup() [3/3]

template<typename Group>

void setupGroup ( Group & group, typename Group::Size entryCount, const void * messageTail )

inlineprotected

Initializes the group header.

Definition at line 1459 of file SbeMessage.h.

    {
        assert(messageTail);
        assert(group.valid());
        group.setup(entryCount, messageTail, blockEnd());
    }

setVarDataField()

template<typename DATA>

void setVarDataField ( DATA & data, StrRef value, const void * oldMessageTail )

inlineprotected

Sets the variable length field value.

Definition at line 1478 of file SbeMessage.h.

    {
        assert(oldMessageTail);
 
        const ptrdiff_t lengthChange = static_cast<ptrdiff_t>(value.length() - data.length());
 
        const void* const newMessageTail = advanceByBytes(oldMessageTail, lengthChange);
 
        if ONIXS_ICEBOE_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);
    }

setVariableLengthField() [1/2]

template<class Callable, class Owner>

void setVariableLengthField ( Callable callable, StrRef value, Owner & owner )

inlineprotected

Sets the value of the variable length field.

Definition at line 1567 of file SbeMessage.h.

    {
        setVarDataField(callable(owner), value, owner.tail());
    }

setVariableLengthField() [2/2]

template<class Callable, class Owner>

void setVariableLengthField ( Callable callable, StrRef value, SchemaVersion since, Owner & owner )

inlineprotected

Sets the value of the variable length field.

Definition at line 1574 of file SbeMessage.h.

    {
        if ONIXS_ICEBOE_UNLIKELY(since > version())
            throwDisallowedField();
 
        setVariableLengthField(callable, value, owner);
    }

setVariableLengthFieldToNull() [1/2]

template<class Callable, class Owner>

void setVariableLengthFieldToNull ( Callable callable, Owner & owner )

inlineprotectednoexcept

Resets the variable length field.

Definition at line 1602 of file SbeMessage.h.

    {
        ONIXS_ICEBOE_CHECK_NOTHROW(callable(owner));
        callable(owner).length(0);
    }

setVariableLengthFieldToNull() [2/2]

template<class Callable, class Owner>

void setVariableLengthFieldToNull ( Callable callable, SchemaVersion since, Owner & owner )

inlineprotectednoexcept

Sets the variable length field to null.

Definition at line 1621 of file SbeMessage.h.

    {
        if ONIXS_ICEBOE_UNLIKELY(since > version())
            return;
 
        setVariableLengthFieldToNull(callable, owner);
    }

templateId()

MessageTemplateId templateId ( ) const

inlinenoexcept

Returns

SBE Template identifier.

Definition at line 1259 of file SbeMessage.h.

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

valid()

bool valid ( ) const

inlinenoexcept

Returns

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

Definition at line 1248 of file SbeMessage.h.

    {
        return (nullptr != header_);
    }

variableLengthFields() [1/2]

VariableLengthFieldList variableLengthFields ( ) const

inlineprotectednoexcept

Returns

the list of variable-length fields.

Definition at line 1516 of file SbeMessage.h.

    {
        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());
    }

variableLengthFields() [2/2]

VariableLengthFieldList variableLengthFields ( )

inlineprotectednoexcept

Returns

the list of variable-length fields.

Definition at line 1503 of file SbeMessage.h.

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

version() [1/2]

SchemaVersion version ( ) const

inlinenoexcept

Returns

SBE Schema version.

Definition at line 1267 of file SbeMessage.h.

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

version() [2/2]

SbeMessage & version ( SchemaVersion version )

inlineprotectednoexcept

Sets the SBE Schema version.

Definition at line 1412 of file SbeMessage.h.

    {
        assert(valid());
 
        header_->version(version);
 
        return *this;
    }