SbeMessage Class Reference

Classes
struct	NoCheck

Public Types
typedef MessageSize	EncodedLength
typedef MessageSize	BlockLength

Public Member Functions
	SbeMessage () noexcept
	SbeMessage (const void *data, MessageSize size)
	SbeMessage (const void *data, MessageSize size, NoCheck) noexcept
void	clear () noexcept
bool	valid () const noexcept
MessageTemplateId	templateId () const noexcept
SchemaVersion	version () const noexcept
SchemaId	schemaId () const noexcept
const void *	binary () const noexcept
const void *	blockEnd () const noexcept
MessageSize	bufferSize () const noexcept
BlockLength	blockLength () const noexcept
const void *	block () const noexcept

Protected Types
typedef SbeGroupList< MessageSize >	GroupList

Protected Member Functions
GroupList	groups () const noexcept
template<class Group, class Callable, class Owner>
Group	getGroup (Callable callable, Owner &owner) const noexcept
template<class Group, class Callable, class Owner>
Group	getGroup (Callable callable, SchemaVersion since, Owner &owner) const noexcept
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
Value	ordinary (MessageSize offset) const noexcept
Enumeration::Enum	enumeration (MessageSize offset) const noexcept
StrRef	fixedStr (MessageSize offset) const noexcept

Detailed Description

Definition at line 796 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 806 of file SbeMessage.h.

EncodedLength

typedef MessageSize EncodedLength

Length of the message binary data.

Definition at line 803 of file SbeMessage.h.

GroupList

typedef SbeGroupList<MessageSize> GroupList

protected

Binary group list instantiation.

Definition at line 924 of file SbeMessage.h.

Constructor & Destructor Documentation

SbeMessage() [1/3]

SbeMessage ( )

inlinenoexcept

Initializes a blank instance.

Definition at line 809 of file SbeMessage.h.

SbeMessage() [2/3]

SbeMessage ( const void * data, MessageSize size )

inline

Initializes the instance over the given memory block.

Definition at line 817 of file SbeMessage.h.

SbeMessage() [3/3]

SbeMessage ( const 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 836 of file SbeMessage.h.

Member Function Documentation

binary()

const void * binary ( ) const

inlinenoexcept

Returns

SBE-encoded message content.

Definition at line 885 of file SbeMessage.h.

block()

const void * block ( ) const

inlinenoexcept

Returns

the beginning of the message body.

Definition at line 915 of file SbeMessage.h.

blockEnd()

const void * blockEnd ( ) const

inlinenoexcept

Definition at line 893 of file SbeMessage.h.

blockLength()

BlockLength blockLength ( ) const

inlinenoexcept

Returns

the size of the message body in bytes.

Definition at line 907 of file SbeMessage.h.

bufferSize()

MessageSize bufferSize ( ) const

inlinenoexcept

Returns

the size of the message buffer.

Definition at line 901 of file SbeMessage.h.

clear()

void clear ( )

inlinenoexcept

Blank the instance.

Definition at line 848 of file SbeMessage.h.

getGroup() [1/2]

template<class Group, class Callable, class Owner>

Group getGroup ( Callable callable, Owner & owner ) const

inlineprotectednoexcept

Returns

the repeating group.

Definition at line 941 of file SbeMessage.h.

getGroup() [2/2]

template<class Group, class Callable, class Owner>

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

inlineprotectednoexcept

Returns

the repeating group.

Definition at line 949 of file SbeMessage.h.

groups()

GroupList groups ( ) const

inlineprotectednoexcept

Returns

the list of repeating groups

Definition at line 928 of file SbeMessage.h.

schemaId()

SchemaId schemaId ( ) const

inlinenoexcept

Returns

SBE Schema ID.

Definition at line 877 of file SbeMessage.h.

templateId()

MessageTemplateId templateId ( ) const

inlinenoexcept

Returns

SBE Template identifier.

Definition at line 861 of file SbeMessage.h.

valid()

bool valid ( ) const

inlinenoexcept

Returns

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

Definition at line 855 of file SbeMessage.h.

version()

SchemaVersion version ( ) const

inlinenoexcept

Returns

SBE Schema version.

Definition at line 869 of file SbeMessage.h.