OnixS C++ CME iLink 3 Binary Order Entry Handler  1.18.9
API Documentation
Public Types | Public Member Functions | List of all members
MessageHolder< MessageTypeT, MaxMessageSize, MessageInitializer > Class Template Reference

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

Public Types

enum  { BufferSize = MaxMessageSize + sizeof(SimpleOpenFramingHeader) }
 
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::CME::iLink3::Messaging::MessageHolder< MessageTypeT, MaxMessageSize, MessageInitializer >

Returns
a human-readable presentation.

Definition at line 212 of file MessageHolder.h.

Member Typedef Documentation

typedef HeldAdapter<MessageTypeT> MessageType

Message type.

Definition at line 271 of file MessageHolder.h.

Member Enumeration Documentation

anonymous enum

Size of the data buffer.

Enumerator
BufferSize 

Definition at line 274 of file MessageHolder.h.

Constructor & Destructor Documentation

MessageHolder ( SchemaVersion  version = SbeType::Schema::Version)
inlineexplicit

Definition at line 279 of file MessageHolder.h.

MessageHolder ( const Session &  session)
inlineexplicit

Definition at line 284 of file MessageHolder.h.

MessageHolder ( const MessageHolder< MessageTypeT, MaxMessageSize, MessageInitializer > &  r)
inline

Definition at line 289 of file MessageHolder.h.

Member Function Documentation

const unsigned char* buffer ( ) const
inlinenoexcept
Returns
the buffer.

Definition at line 301 of file MessageHolder.h.

UInt16 bufferSize ( ) const
inlinenoexcept
Returns
the used size of the buffer.

Definition at line 307 of file MessageHolder.h.

const SimpleOpenFramingHeader* header ( ) const
inlinenoexcept
Returns
Simple Open Framing Header

Definition at line 351 of file MessageHolder.h.

SimpleOpenFramingHeader* header ( )
inlinenoexcept
Returns
Simple Open Framing Header

Definition at line 357 of file MessageHolder.h.

MessageType& message ( )
inlinenoexcept
Returns
the SBE message.

Definition at line 313 of file MessageHolder.h.

const MessageType& message ( ) const
inlinenoexcept
Returns
the SBE message.

Definition at line 319 of file MessageHolder.h.

UInt16 messageSize ( ) const
inlinenoexcept
Returns
the SBE message size

Definition at line 325 of file MessageHolder.h.

const MessageType& operator* ( ) const
inlinenoexcept

Definition at line 340 of file MessageHolder.h.

MessageType& operator* ( )
inlinenoexcept

Definition at line 345 of file MessageHolder.h.

MessageType* operator-> ( )
inlinenoexcept

Definition at line 330 of file MessageHolder.h.

const MessageType* operator-> ( ) const
inlinenoexcept

Definition at line 335 of file MessageHolder.h.

MessageHolder& operator= ( const MessageHolder< MessageTypeT, MaxMessageSize, MessageInitializer > &  r)
inline

Definition at line 294 of file MessageHolder.h.

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 366 of file MessageHolder.h.

NetworkMessage toNetworkMessage ( )
inlinenoexcept

Definition at line 384 of file MessageHolder.h.

std::string toString ( ) const
inline
Returns
a human-readable presentation.

Definition at line 396 of file MessageHolder.h.

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