#include <OnixS/B3/MarketData/UMDF/messaging/SbeMessage.h>

Classes
struct	NoCheck

struct	NoFieldsInit

struct	NoInit

Public Types
typedef MessageSize	EncodedLength

typedef MessageSize	BlockLength

Public Member Functions
	SbeMessage () throw ()

ONIXS_B3_UMDF_MD_HOTPATH	SbeMessage (const void *data, MessageSize size)

ONIXS_B3_UMDF_MD_HOTPATH	SbeMessage (void *data, MessageSize size, NoCheck) throw ()

void	clear () throw ()

bool	valid () const throw ()

MessageTemplateId	templateId () const throw ()

SchemaVersion	version () const throw ()

SchemaId	schemaId () const throw ()

const void *	binary () const throw ()

const void *	blockEnd () throw ()

const void *	blockEnd () const throw ()

MessageSize	bufferSize () const throw ()

BlockLength	blockLength () const throw ()

const void *	block () const throw ()

Public Member Functions inherited from SbeFields< Messaging::SbeMessage, MessageSize >
Messaging::SbeMessage &	container () throw ()

ONIXS_B3_UMDF_MD_HOTPATH void	zeroPaddingBytes (MessageSizeoffset) throw ()

ONIXS_B3_UMDF_MD_HOTPATH void	setOrdinary (MessageSizeoffset, FieldValue value) throw ()

ONIXS_B3_UMDF_MD_HOTPATH void	setOrdinary (MessageSizeoffset, FieldValue value, SchemaVersion since)

ONIXS_B3_UMDF_MD_HOTPATH void	setEnumeration (MessageSizeoffset, typename Enumeration::Enum value) throw ()

ONIXS_B3_UMDF_MD_HOTPATH void	setEnumeration (MessageSizeoffset, typename Enumeration::Enum value, SchemaVersion since)

ONIXS_B3_UMDF_MD_HOTPATH void	setFixedStr (MessageSizeoffset, StrRef value) throw ()

ONIXS_B3_UMDF_MD_HOTPATH void	setFixedStr (MessageSizeoffset, StrRef value, SchemaVersion since)

Protected Types
typedef SbeGroupList< MessageSize >	GroupList

typedef SbeVariableLengthFieldList< MessageSize >	VariableLengthFieldList

Protected Member Functions
ONIXS_B3_UMDF_MD_HOTPATH GroupList	groups () const throw ()

template<typename Group >
ONIXS_B3_UMDF_MD_HOTPATH void	initGroup (Group &group, typename Group::EntrySize entrySize) throw ()

template<typename Group >
ONIXS_B3_UMDF_MD_HOTPATH void	setupGroup (Group &group, typename Group::Size entryCount, const void *messageTail)

template<typename Group >
ONIXS_B3_UMDF_MD_HOTPATH void	constructGroup (Group &group, typename Group::Size entryCount, const void *messageTail)

ONIXS_B3_UMDF_MD_HOTPATH VariableLengthFieldList	variableLengthFields () const throw ()

ONIXS_B3_UMDF_MD_HOTPATH MessageSize	calculateBinarySize (const void *tail) const throw ()

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 throw ()

template<class Callable , class Owner >
StrRef	getVariableLengthField (Callable callable, SchemaVersion since, Owner &owner) const throw ()

template<class Callable , class Owner >
void	setVariableLengthFieldToNull (Callable callable, Owner &owner) throw ()

template<class Group , class Callable , class Owner >
void	resetGroup (Callable callable, Owner &owner) throw ()

template<class Callable , class Owner >
void	setVariableLengthFieldToNull (Callable callable, SchemaVersion since, Owner &owner) throw ()

template<class Group , class Callable , class Owner >
void	resetGroup (Callable callable, SchemaVersion since, Owner &owner)

template<class Group , class Callable , class Owner >
Group	getGroup (Callable callable, Owner &owner) const throw ()

template<class Group , class Callable , class Owner >
Group	getGroup (Callable callable, SchemaVersion since, Owner &owner) const throw ()

template<class Group , class Callable , class Owner >
Group	constructGroup (Callable callable, typename Group::Size length, SchemaVersion since, Owner &owner)

template<class Group , class Callable , class Owner >
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 ()

	~SbeFields ()

Protected Member Functions inherited from BinaryBlock< Messaging::SbeMessage, MessageSize >
	BinaryBlock ()

	~BinaryBlock ()

ONIXS_B3_UMDF_MD_HOTPATH Value	ordinary (MessageSizeoffset) const throw ()

ONIXS_B3_UMDF_MD_HOTPATH bool	ordinary (Value &value, MessageSizeoffset, NullValue null) const throw ()

ONIXS_B3_UMDF_MD_HOTPATH bool	ordinary (Value &value, MessageSizeoffset, NullValue null, SchemaVersion since) const throw ()

ONIXS_B3_UMDF_MD_HOTPATH Enumeration::Enum	enumeration (MessageSizeoffset) const throw ()

ONIXS_B3_UMDF_MD_HOTPATH bool	enumeration (typename Enumeration::Enum &value, MessageSizeoffset, NullValue null) const throw ()

ONIXS_B3_UMDF_MD_HOTPATH bool	enumeration (typename Enumeration::Enum &value, MessageSizeoffset, NullValue null, SchemaVersion since) const throw ()

ONIXS_B3_UMDF_MD_HOTPATH Value	decimal (MessageSizeoffset) const throw ()

ONIXS_B3_UMDF_MD_HOTPATH bool	decimal (Value &value, MessageSizeoffset, NullValue null) const throw ()

ONIXS_B3_UMDF_MD_HOTPATH bool	decimal (Value &value, MessageSizeoffset, NullValue null, SchemaVersion since) const throw ()

ONIXS_B3_UMDF_MD_HOTPATH StrRef	fixedStr (MessageSizeoffset) const throw ()

ONIXS_B3_UMDF_MD_HOTPATH bool	fixedStr (StrRef &value, MessageSizeoffset) const throw ()

ONIXS_B3_UMDF_MD_HOTPATH bool	fixedStr (StrRef &value, MessageSizeoffset, SchemaVersion since) const throw ()

Static Protected Member Functions
ONIXS_B3_UMDF_MD_API static ONIXS_B3_UMDF_MD_NODISCARD MessageSize	getMaxMessageSize () throw ()

Detailed Description

Definition at line 1108 of file SbeMessage.h.

Member Typedef Documentation

typedef MessageSize BlockLength

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

Definition at line 1120 of file SbeMessage.h.

typedef MessageSize EncodedLength

Length of the message binary data.

Definition at line 1117 of file SbeMessage.h.

typedef SbeGroupList<MessageSize> GroupList

protected

Binary group list instantiation.

Definition at line 1285 of file SbeMessage.h.

typedef SbeVariableLengthFieldList<MessageSize> VariableLengthFieldList

protected

Sets the variable length field value.

Binary group list instantiation.

Definition at line 1374 of file SbeMessage.h.

Constructor & Destructor Documentation

SbeMessage	(	)
throw	(
	)

inline

Initializes a blank instance.

Definition at line 1123 of file SbeMessage.h.

ONIXS_B3_UMDF_MD_HOTPATH SbeMessage	(	const void *	data,
		MessageSize	size
	)

inline

Initializes the instance over the given memory block.

Definition at line 1146 of file SbeMessage.h.

ONIXS_B3_UMDF_MD_HOTPATH SbeMessage	(	void *	data,
		MessageSize	size,
		NoCheck
	)
throw	(
	)

inline

Initializes the instance over the given memory block.

Note: Performs no check of the data consistency

Definition at line 1165 of file SbeMessage.h.

Member Function Documentation

const void* binary	(	)	const
throw	(
	)

inline

Returns: SBE-encoded message content.

Definition at line 1214 of file SbeMessage.h.

const void* block	(	)	const
throw	(
	)

inline

Returns: the beginning of the message body.

Definition at line 1268 of file SbeMessage.h.

const void* blockEnd	(	)
throw	(
	)

inline

Definition at line 1230 of file SbeMessage.h.

const void* blockEnd	(	)	const
throw	(
	)

inline

Definition at line 1238 of file SbeMessage.h.

BlockLength blockLength	(	)	const
throw	(
	)

inline

Returns: the size of the message body in bytes.

Definition at line 1260 of file SbeMessage.h.

MessageSize bufferSize	(	)	const
throw	(
	)

inline

Returns: the size of the message buffer.

Definition at line 1246 of file SbeMessage.h.

ONIXS_B3_UMDF_MD_HOTPATH MessageSize calculateBinarySize	(	const void *	tail	)	const
throw	(
	)

inlineprotected

Definition at line 1420 of file SbeMessage.h.

void clear	(	)
throw	(
	)

inline

Blank the instance.

Definition at line 1177 of file SbeMessage.h.

ONIXS_B3_UMDF_MD_HOTPATH 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 1345 of file SbeMessage.h.

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 1531 of file SbeMessage.h.

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 1541 of file SbeMessage.h.

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

inlineprotected

Returns: the repeating group.

Definition at line 1513 of file SbeMessage.h.

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

inlineprotected

Returns: the repeating group.

Definition at line 1521 of file SbeMessage.h.

ONIXS_B3_UMDF_MD_API static ONIXS_B3_UMDF_MD_NODISCARD MessageSize getMaxMessageSize	(	)
throw	(
	)

inlinestaticprotected

Maximal message size.

Definition at line 1575 of file SbeMessage.h.

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

inlineprotected

Returns: the value of the variable length field.

Definition at line 1456 of file SbeMessage.h.

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

inlineprotected

Returns: the value of the variable length field.

Definition at line 1464 of file SbeMessage.h.

ONIXS_B3_UMDF_MD_HOTPATH GroupList groups	(	)	const
throw	(
	)

inlineprotected

Returns: the list of repeating groups

Definition at line 1312 of file SbeMessage.h.

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

inlineprotected

Resets the group to the initial state.

Definition at line 1326 of file SbeMessage.h.

void resetGroup	(	Callable	callable,
		Owner &	owner
	)
throw	(
	)

inlineprotected

Sets the group to the initial state.

Definition at line 1482 of file SbeMessage.h.

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

inlineprotected

Resets the repeating group.

Definition at line 1503 of file SbeMessage.h.

SchemaId schemaId	(	)	const
throw	(
	)

inline

Returns: SBE Schema ID.

Definition at line 1206 of file SbeMessage.h.

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

inlineprotected

Initializes the group header.

Definition at line 1335 of file SbeMessage.h.

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 1552 of file SbeMessage.h.

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

inlineprotected

Setups the repeating group with the given number of entries.

Definition at line 1562 of file SbeMessage.h.

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

inlineprotected

Sets the value of the variable length field.

Definition at line 1439 of file SbeMessage.h.

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

inlineprotected

Sets the value of the variable length field.

Definition at line 1446 of file SbeMessage.h.

void setVariableLengthFieldToNull	(	Callable	callable,
		Owner &	owner
	)
throw	(
	)

inlineprotected

Resets the variable length field.

Definition at line 1474 of file SbeMessage.h.

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

inlineprotected

Sets the variable length field to null.

Definition at line 1493 of file SbeMessage.h.

MessageTemplateId templateId	(	)	const
throw	(
	)

inline

Returns: SBE Template identifier.

Definition at line 1190 of file SbeMessage.h.

bool valid	(	)	const
throw	(
	)

inline

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

Definition at line 1184 of file SbeMessage.h.

ONIXS_B3_UMDF_MD_HOTPATH VariableLengthFieldList variableLengthFields	(	)	const
throw	(
	)

inlineprotected

Returns: the list of variable-length fields.

Definition at line 1391 of file SbeMessage.h.

SchemaVersion version	(	)	const
throw	(
	)

inline

Returns: SBE Schema version.

Definition at line 1198 of file SbeMessage.h.

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

OnixS/B3/MarketData/UMDF/messaging/SbeMessage.h

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation