BinaryMessage Class Reference

#include <OnixS/CME/ConflatedUDP/BinaryMessage.h>

Classes
class	NoVersionCheck

Public Types
typedef MessageSize	EncodedLength
typedef MessageSize	BlockLength
typedef BinaryGroups< MessageSize >	Groups

Public Member Functions
	BinaryMessage ()
	BinaryMessage (const void *encoded, EncodedLength length)
	BinaryMessage (const BinaryMessage &other)
	operator bool () const
MessageTemplateId	templateId () const
SchemaVersion	version () const
const void *	encoded () const
EncodedLength	encodedLength () const
const void *	block () const
BlockLength	blockLength () const
Groups	groups () const
BinaryMessage &	operator= (const BinaryMessage &other)

Protected Member Functions
	BinaryMessage (const void *encoded, EncodedLength length, NoVersionCheck)
Protected Member Functions inherited from BinaryBlock< BinaryMessage, MessageSize >
	BinaryBlock ()
	~BinaryBlock ()
Value	ordinary (MessageSizeoffset) const
bool	ordinary (Value &value, MessageSizeoffset, const NullValue &null) const
bool	ordinary (Value &value, MessageSizeoffset, const NullValue &null, SchemaVersion since) const
Enumeration::Enum	enumeration (MessageSizeoffset) const
bool	enumeration (typename Enumeration::Enum &value, MessageSizeoffset, const NullValue &null) const
bool	enumeration (typename Enumeration::Enum &value, MessageSizeoffset, const NullValue &null, SchemaVersion since) const
Decimal	decimal (MessageSizeoffset) const
bool	decimal (Decimal &value, MessageSizeoffset, const NullValue &null) const
bool	decimal (Decimal &value, MessageSizeoffset, const NullValue &null, SchemaVersion since) const
StrRef	fixedStr (MessageSizeoffset) const
StrRef	fixedStr (MessageSizeoffset, SchemaVersion since) const

Detailed Description

Definition at line 1325 of file BinaryMessage.h.

Member Typedef Documentation

typedef MessageSize BlockLength

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

Definition at line 1350 of file BinaryMessage.h.

typedef MessageSize EncodedLength

Length of message binary data.

Definition at line 1346 of file BinaryMessage.h.

typedef BinaryGroups<MessageSize> Groups

Repeating groups.

Definition at line 1355 of file BinaryMessage.h.

Constructor & Destructor Documentation

BinaryMessage ( )

inline

Initializes the instance referencing to nothing.

Definition at line 1358 of file BinaryMessage.h.

BinaryMessage ( const void *  encoded, EncodedLength  length  )

inline

Initializes instance over the given encoded data.

Definition at line 1365 of file BinaryMessage.h.

BinaryMessage ( const BinaryMessage &  other )

inline

Initializes instance as copy of the other one.

Definition at line 1402 of file BinaryMessage.h.

BinaryMessage ( const void *  encoded, EncodedLength  length, NoVersionCheck    )

inlineprotected

Definition at line 1500 of file BinaryMessage.h.

Member Function Documentation

const void* block ( ) const

inline

Indicates beginning of message body.

Definition at line 1446 of file BinaryMessage.h.

BlockLength blockLength ( ) const

inline

Length of the message body ( block of fixed-length fields).

Definition at line 1458 of file BinaryMessage.h.

const void* encoded ( ) const

inline

SBE-encoded message content.

Definition at line 1434 of file BinaryMessage.h.

EncodedLength encodedLength ( ) const

inline

Size of SBE-encoded message.

Definition at line 1440 of file BinaryMessage.h.

Groups groups ( ) const

inline

Collection of repeating groups of the message being referenced.

Definition at line 1467 of file BinaryMessage.h.

operator bool ( ) const

inline

Indicates whether instance refers to a valid message.

Definition at line 1412 of file BinaryMessage.h.

BinaryMessage& operator= ( const BinaryMessage &  other )

inline

Re-initializes instance as a copy of the other one.

Definition at line 1488 of file BinaryMessage.h.

MessageTemplateId templateId ( ) const

inline

Template identifier of message being referenced.

Definition at line 1418 of file BinaryMessage.h.

SchemaVersion version ( ) const

inline

Version of message being referenced.

Definition at line 1426 of file BinaryMessage.h.

---

The documentation for this class was generated from the following file:

• include/OnixS/CME/ConflatedUDP/BinaryMessage.h