MFClient  1.3.0
 All Classes Functions Variables Enumerations
Public Member Functions | List of all members
MFProtoMsgWrapper< T > Class Template Reference

A wrapper to encapsulate an SBE class instance and the buffer where the message payload is actually stored. Instances of this are returned by calls to the create... methods of MFTradingSession and MFProtoOutputBufferProvider More...

#include <MFProtoMsgWrapper.h>

Inheritance diagram for MFProtoMsgWrapper< T >:

Public Member Functions

T & msg ()
 Return a reference to the message object. Note that if the message has been sent, this reference will no longer be usable and needs to be reset by a call to a create method or calling reset() or reset(size_t msgSize) directly. More...
 
MFProtoOutputBuffer & buf ()
 Return a reference to the buffer where the object payload is stored. More...
 
void reset ()
 Clear out the buffer - resetting counters to the beginning. Allocate a block of the buffer for the header data and the message payload - the size of which is T::sbeBlockLength(). More...
 
void reset (size_t msgSize)
 Clear out the buffer - resetting counters to the beginning. Allocate a block of the buffer for the header data and the message payload - the size of which is the msgSize param.

Parameters
msgSizeThe message payload size. This is presumably a combination of T::sbeBlockLength() and the size of variable size elements
More...
 

Detailed Description

template<class T>
class MFProtoMsgWrapper< T >

A wrapper to encapsulate an SBE class instance and the buffer where the message payload is actually stored. Instances of this are returned by calls to the create... methods of MFTradingSession and MFProtoOutputBufferProvider

Member Function Documentation

template<class T>
MFProtoOutputBuffer& MFProtoMsgWrapper< T >::buf ( )
inline

Return a reference to the buffer where the object payload is stored.

template<class T>
T& MFProtoMsgWrapper< T >::msg ( )
inline

Return a reference to the message object. Note that if the message has been sent, this reference will no longer be usable and needs to be reset by a call to a create method or calling reset() or reset(size_t msgSize) directly.

template<class T>
void MFProtoMsgWrapper< T >::reset ( )
inline

Clear out the buffer - resetting counters to the beginning. Allocate a block of the buffer for the header data and the message payload - the size of which is T::sbeBlockLength().

template<class T>
void MFProtoMsgWrapper< T >::reset ( size_t  msgSize)
inline

Clear out the buffer - resetting counters to the beginning. Allocate a block of the buffer for the header data and the message payload - the size of which is the msgSize param.

Parameters
msgSizeThe message payload size. This is presumably a combination of T::sbeBlockLength() and the size of variable size elements


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