OnixS C++ B3 BOE Binary Order Entry 1.3.0
API Documentation
Loading...
Searching...
No Matches
MessageHolder< MessageTypeT, MaxMessageSize, MessageInitializer > Class Template Reference

Public Types

enum  
typedef HeldAdapter< MessageTypeT > MessageType

Public Member Functions

 MessageHolder (SchemaVersion version=SbeType::Schema::Version)
 MessageHolder (const Session &session)
 MessageHolder (const MessageHolder &r)
MessageHolder & operator= (const MessageHolder &r)
const unsigned char * buffer () const noexcept
UInt16 bufferSize () const noexcept
MessageType & message () noexcept
const MessageType & message () const noexcept
UInt16 messageSize () const noexcept
MessageType * operator-> () noexcept
const MessageType * operator-> () const noexcept
const MessageType & operator* () const noexcept
MessageType & operator* () noexcept
const SimpleOpenFramingHeader * header () const noexcept
SimpleOpenFramingHeader * header () noexcept
MessageSize setHeader () noexcept
NetworkMessage toNetworkMessage () noexcept
std::string toString () const

Detailed Description

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
class OnixS::B3::BOE::Messaging::MessageHolder< MessageTypeT, MaxMessageSize, MessageInitializer >
Returns
a human-readable presentation.

Definition at line 183 of file MessageHolder.h.

Member Typedef Documentation

◆ MessageType

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

Message type.

Definition at line 201 of file MessageHolder.h.

Member Enumeration Documentation

◆ anonymous enum

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

Size of the data buffer.

Enumerator
BufferSize MaxMessageSize + sizeof(SimpleOpenFramingHeader) 

Definition at line 204 of file MessageHolder.h.

Constructor & Destructor Documentation

◆ MessageHolder() [1/3]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
MessageHolder ( SchemaVersion version = SbeType::Schema::Version)
inlineexplicit

Definition at line 209 of file MessageHolder.h.

◆ MessageHolder() [2/3]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
MessageHolder ( const Session & session)
inlineexplicit

Definition at line 214 of file MessageHolder.h.

◆ MessageHolder() [3/3]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
MessageHolder ( const MessageHolder< MessageTypeT, MaxMessageSize, MessageInitializer > & r)
inline

Definition at line 219 of file MessageHolder.h.

Member Function Documentation

◆ buffer()

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
const unsigned char * buffer ( ) const
inlinenoexcept
Returns
the buffer.

Definition at line 231 of file MessageHolder.h.

◆ bufferSize()

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
UInt16 bufferSize ( ) const
inlinenoexcept
Returns
the used size of the buffer.

Definition at line 237 of file MessageHolder.h.

◆ header() [1/2]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
const SimpleOpenFramingHeader * header ( ) const
inlinenoexcept
Returns
Simple Open Framing Header

Definition at line 281 of file MessageHolder.h.

◆ header() [2/2]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
SimpleOpenFramingHeader * header ( )
inlinenoexcept
Returns
Simple Open Framing Header

Definition at line 287 of file MessageHolder.h.

◆ message() [1/2]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
const MessageType & message ( ) const
inlinenoexcept
Returns
the SBE message.

Definition at line 249 of file MessageHolder.h.

◆ message() [2/2]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
MessageType & message ( )
inlinenoexcept
Returns
the SBE message.

Definition at line 243 of file MessageHolder.h.

◆ messageSize()

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
UInt16 messageSize ( ) const
inlinenoexcept
Returns
the SBE message size

Definition at line 255 of file MessageHolder.h.

◆ operator*() [1/2]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
const MessageType & operator* ( ) const
inlinenoexcept

Definition at line 270 of file MessageHolder.h.

◆ operator*() [2/2]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
MessageType & operator* ( )
inlinenoexcept

Definition at line 275 of file MessageHolder.h.

◆ operator->() [1/2]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
const MessageType * operator-> ( ) const
inlinenoexcept

Definition at line 265 of file MessageHolder.h.

◆ operator->() [2/2]

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
MessageType * operator-> ( )
inlinenoexcept

Definition at line 260 of file MessageHolder.h.

◆ operator=()

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
MessageHolder & operator= ( const MessageHolder< MessageTypeT, MaxMessageSize, MessageInitializer > & r)
inline

Definition at line 224 of file MessageHolder.h.

◆ setHeader()

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
MessageSize setHeader ( )
inlinenoexcept

Calculates the binary size of the message and updates the Simple Open Framing Header accordingly.

Returns
SBE message size

Definition at line 296 of file MessageHolder.h.

◆ toNetworkMessage()

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
NetworkMessage toNetworkMessage ( )
inlinenoexcept

Definition at line 314 of file MessageHolder.h.

◆ toString()

template<typename MessageTypeT, size_t MaxMessageSize = GetMaxMessageSize<typename HeldAdapter<MessageTypeT>::SbeType, DefaultMaxGroupItems>::Size, typename MessageInitializer = FieldsInitPolicy>
std::string toString ( ) const
inline
Returns
a human-readable presentation.

Definition at line 326 of file MessageHolder.h.