MessageBatch< MessageTypeT, MaxMessageSize, MessageInitializer > Class Template Reference

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::ICE::BOE::Session
class	OnixS::ICE::BOE::Messaging::MessageBatchChecker

Detailed Description

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

Definition at line 45 of file MessageBatch.h.

Member Typedef Documentation

const_iterator

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

using const_iterator = typename MsgHolders::const_iterator

Definition at line 53 of file MessageBatch.h.

iterator

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

using iterator = typename MsgHolders::iterator

Definition at line 52 of file MessageBatch.h.

MsgHolder

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

using MsgHolder = MessageHolder<MessageTypeT, MaxMessageSize, MessageInitializer>

Definition at line 49 of file MessageBatch.h.

MsgHolders

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

using MsgHolders = std::vector<MsgHolder>

Definition at line 50 of file MessageBatch.h.

Constructor & Destructor Documentation

MessageBatch() [1/4]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

MessageBatch ( )

default

Creates an empty message batch.

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

MessageBatch() [2/4]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

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 65 of file MessageBatch.h.

                                       : batch_(size)
    {
        updateHeaders();
    }

MessageBatch() [3/4]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

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 74 of file MessageBatch.h.

                                                      : batch_(list)
    {
        updateHeaders();
    }

MessageBatch() [4/4]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

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

delete

Member Function Documentation

add()

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

void add ( const MsgHolder & msg )

inline

Appends a message to the end of the batch.

Definition at line 85 of file MessageBatch.h.

    {
        batch_.push_back(msg);
    }

begin() [1/2]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

iterator begin ( )

inline

Definition at line 111 of file MessageBatch.h.

{ return batch_.begin(); }

begin() [2/2]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

const_iterator begin ( ) const

inline

Definition at line 110 of file MessageBatch.h.

{ return batch_.begin(); }

end() [1/2]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

iterator end ( )

inline

Definition at line 114 of file MessageBatch.h.

{ return batch_.end(); }

end() [2/2]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

const_iterator end ( ) const

inline

Definition at line 113 of file MessageBatch.h.

{ return batch_.end(); }

operator=()

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

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

delete

operator[]() [1/2]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

MsgHolder & operator[] ( size_t index )

inline

Definition at line 105 of file MessageBatch.h.

{ return batch_[index]; }

operator[]() [2/2]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

const MsgHolder & operator[] ( size_t index ) const

inline

Definition at line 106 of file MessageBatch.h.

{ return batch_[index]; }

size()

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

size_t size ( ) const

inline

Definition at line 108 of file MessageBatch.h.

{ return batch_.size(); }

updateHeaders()

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

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 97 of file MessageBatch.h.

    {
        netMsgs_.resize(batch_.size());
 
        for (size_t counter = 0; counter < batch_.size(); ++counter)
            netMsgs_[counter] = batch_[counter].toNetworkMessage();
    }

Friends And Related Symbol Documentation

OnixS::ICE::BOE::Messaging::MessageBatchChecker

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

friend class OnixS::ICE::BOE::Messaging::MessageBatchChecker

friend

Definition at line 119 of file MessageBatch.h.

OnixS::ICE::BOE::Session

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>

friend class OnixS::ICE::BOE::Session

friend

Definition at line 118 of file MessageBatch.h.