MessageBatch< MessageTypeT, MaxMessageSize, MessageInitializer > Class Template Reference

#include <OnixS/CME/iLink3/messaging/MessageBatch.h>

Public Types
using	MsgHolder = MessageHolder< MessageTypeT, MaxMessageSize, MessageInitializer >
using	MsgHolders = std::vector< MsgHolder >
using	iterator = typename MsgHolders::iterator
using	const_iterator = typename MsgHolders::const_iterator

Public Member Functions
	MessageBatch ()=default
	MessageBatch (size_t size)
	MessageBatch (std::initializer_list< MsgHolder > list)
	MessageBatch (const MessageBatch &)=delete
MessageBatch &	operator= (const MessageBatch &)=delete
void	add (const MsgHolder &msg)
void	updateHeaders ()
MsgHolder &	operator[] (size_t index)
const MsgHolder &	operator[] (size_t index) const
size_t	size () const
const_iterator	begin () const
iterator	begin ()
const_iterator	end () const
iterator	end ()

Friends
class	OnixS::CME::iLink3::Session
class	OnixS::CME::iLink3::Messaging::MessageBatchChecker

Detailed Description

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
class OnixS::CME::iLink3::Messaging::MessageBatch< MessageTypeT, MaxMessageSize, MessageInitializer >

Definition at line 53 of file MessageBatch.h.

Member Typedef Documentation

using const_iterator = typename MsgHolders::const_iterator

Definition at line 61 of file MessageBatch.h.

using iterator = typename MsgHolders::iterator

Definition at line 60 of file MessageBatch.h.

using MsgHolder = MessageHolder<MessageTypeT, MaxMessageSize, MessageInitializer>

Definition at line 57 of file MessageBatch.h.

using MsgHolders = std::vector<MsgHolder>

Definition at line 58 of file MessageBatch.h.

Constructor & Destructor Documentation

MessageBatch ( )

default

Creates an empty message batch.

The add method should be used to add a message to the batch.

MessageBatch ( size_t  size )

inlineexplicit

Creates a message batch with the given number of default constructed messages.

A message in the batch can be updated via operator[] method.

Definition at line 73 of file MessageBatch.h.

MessageBatch ( std::initializer_list< MsgHolder >  list )

inline

Creates a message batch from the initializer list.

A message in the batch can be updated via operator[] method.

Definition at line 82 of file MessageBatch.h.

MessageBatch ( const MessageBatch< MessageTypeT, MaxMessageSize, MessageInitializer > &  )

delete

Member Function Documentation

void add ( const MsgHolder &  msg )

inline

Appends a message to the end of the batch.

Definition at line 93 of file MessageBatch.h.

const_iterator begin ( ) const

inline

Definition at line 118 of file MessageBatch.h.

iterator begin ( )

inline

Definition at line 119 of file MessageBatch.h.

const_iterator end ( ) const

inline

Definition at line 121 of file MessageBatch.h.

iterator end ( )

inline

Definition at line 122 of file MessageBatch.h.

MessageBatch& operator= ( const MessageBatch< MessageTypeT, MaxMessageSize, MessageInitializer > &  )

delete

MsgHolder& operator[] ( size_t  index )

inline

Definition at line 113 of file MessageBatch.h.

const MsgHolder& operator[] ( size_t  index ) const

inline

Definition at line 114 of file MessageBatch.h.

size_t size ( ) const

inline

Definition at line 116 of file MessageBatch.h.

void updateHeaders ( )

inline

Updates headers of SBE messages to be ready for sending.

Note

Should be called before sending after the completion of the batch filling.

There is no need to call this function before sending in each case of a value updating of an existing field.

Definition at line 105 of file MessageBatch.h.

Friends And Related Function Documentation

friend class OnixS::CME::iLink3::Messaging::MessageBatchChecker

friend

Definition at line 127 of file MessageBatch.h.

friend class OnixS::CME::iLink3::Session

friend

Definition at line 126 of file MessageBatch.h.

---

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

• OnixS/CME/iLink3/messaging/MessageBatch.h