OnixS C++ CME iLink 3 Binary Order Entry Handler  1.14.0
API Documentation
EstablishmentAck504 Struct Reference

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

Public Types

enum  { TemplateId = 504 }
 
typedef SchemaTraits Schema
 
typedef EstablishmentAck504 ThisType
 
- Public Types inherited from SbeMessage
typedef MessageSize EncodedLength
 
typedef MessageSize BlockLength
 

Public Member Functions

 EstablishmentAck504 ()
 
 EstablishmentAck504 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
 
 EstablishmentAck504 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
 
 EstablishmentAck504 (void *data, EncodedLength length, NoInit)
 
 EstablishmentAck504 (const SbeMessage &message)
 
 EstablishmentAck504 (void *data, EncodedLength length, NoInit, NoCheck) noexcept
 
UInt64 uuId () const noexcept
 
ThisTypesetUuId (UInt64 value) noexcept
 
UInt64 requestTimestamp () const noexcept
 
ThisTypesetRequestTimestamp (UInt64 value) noexcept
 
UInt32 nextSeqNo () const noexcept
 
ThisTypesetNextSeqNo (UInt32 value) noexcept
 
UInt32 previousSeqNo () const noexcept
 
ThisTypesetPreviousSeqNo (UInt32 value) noexcept
 
UInt64 previousUUId () const noexcept
 
ThisTypesetPreviousUUId (UInt64 value) noexcept
 
UInt16 keepAliveInterval () const noexcept
 
ThisTypesetKeepAliveInterval (UInt16 value) noexcept
 
bool secretKeySecureIdExpiration (UInt16 &value) const noexcept
 
ThisTypesetSecretKeySecureIdExpiration (UInt16 value) noexcept
 
ThisTypesetSecretKeySecureIdExpirationToNull () noexcept
 
bool faultToleranceIndicator (FTI::Enum &value) const noexcept
 
ThisTypesetFaultToleranceIndicator (FTI::Enum value) noexcept
 
ThisTypesetFaultToleranceIndicatorToNull () noexcept
 
bool splitMsg (SplitMsg::Enum &value) const noexcept
 
ThisTypesetSplitMsg (SplitMsg::Enum value) noexcept
 
ThisTypesetSplitMsgToNull () noexcept
 
ThisTyperesetVariableFields () noexcept
 
ThisTypereset () noexcept
 
std::string toString () const
 
const void * tail () const noexcept
 
EncodedLength calculateBinarySize () const noexcept
 
- Public Member Functions inherited from SbeMessage
 SbeMessage () noexcept
 
 SbeMessage (void *data, MessageSize size, SchemaVersion version)
 
 SbeMessage (void *data, MessageSize size)
 
 SbeMessage (void *data, MessageSize size, NoCheck) noexcept
 
void clear () noexcept
 
bool valid () const noexcept
 
MessageTemplateId templateId () const noexcept
 
SchemaVersion version () const noexcept
 
SchemaId schemaId () const noexcept
 
const void * binary () const noexcept
 
void * binary () noexcept
 
const void * blockEnd () noexcept
 
const void * blockEnd () const noexcept
 
MessageSize bufferSize () const noexcept
 
void * body () noexcept
 
BlockLength blockLength () const noexcept
 
const void * block () const noexcept
 
void * block () noexcept
 
- Public Member Functions inherited from SbeFields< Messaging::SbeMessage, MessageSize >
Messaging::SbeMessagecontainer () noexcept
 
void zeroPaddingBytes (MessageSize offset) noexcept
 
void setOrdinary (MessageSize offset, FieldValue value) noexcept
 
void setOrdinary (MessageSize offset, FieldValue value, SchemaVersion since)
 
void setEnumeration (MessageSize offset, typename Enumeration::Enum value) noexcept
 
void setEnumeration (MessageSize offset, typename Enumeration::Enum value, SchemaVersion since)
 
void setFixedStr (MessageSize offset, StrRef value) noexcept
 
void setFixedStr (MessageSize offset, StrRef value, SchemaVersion since)
 

Static Public Member Functions

static constexpr BlockLength minimalBlockLength (SchemaVersion version) noexcept
 
static constexpr BlockLength blockLength (SchemaVersion version) noexcept
 
static constexpr MessageSize getMinimalVariableFieldsSize (SchemaVersion version)
 
static constexpr UInt64 getMaxMessageSize (UInt8) noexcept
 
static constexpr const CharclassName ()
 
static constexpr StrRef fixType () noexcept
 

Additional Inherited Members

- Protected Types inherited from SbeMessage
typedef SbeGroupList< MessageSizeGroupList
 
typedef SbeVariableLengthFieldList< MessageSizeVariableLengthFieldList
 
- Protected Member Functions inherited from SbeMessage
SbeMessageversion (SchemaVersion version) noexcept
 
GroupList groups () noexcept
 
GroupList groups () const noexcept
 
template<typename Group >
void initGroup (Group &group, typename Group::EntrySize entrySize) noexcept
 
template<typename Group >
void setupGroup (Group &group, typename Group::Size entryCount, const void *messageTail)
 
template<typename Group >
void constructGroup (Group &group, typename Group::Size entryCount, const void *messageTail)
 
void setVarDataField (DATA &data, StrRef value, const void *oldMessageTail)
 
VariableLengthFieldList variableLengthFields () noexcept
 
VariableLengthFieldList variableLengthFields () const noexcept
 
void init (MessageHeader::TemplateId value, MessageHeader::BlockLength minimalBlockLength, MessageHeader::BlockLength blockLength, SchemaId id) noexcept
 
MessageSize calculateBinarySize (const void *tail) const noexcept
 
template<class Callable , class Owner >
void setVariableLengthField (Callable callable, StrRef value, Owner &owner)
 
template<class Callable , class Owner >
void setVariableLengthField (Callable callable, StrRef value, SchemaVersion since, Owner &owner)
 
template<class Callable , class Owner >
StrRef getVariableLengthField (Callable callable, const Owner &owner) const noexcept
 
template<class Callable , class Owner >
StrRef getVariableLengthField (Callable callable, SchemaVersion since, Owner &owner) const noexcept
 
template<class Callable , class Owner >
void setVariableLengthFieldToNull (Callable callable, Owner &owner) noexcept
 
template<class Group , class Callable , class Owner >
void resetGroup (Callable callable, Owner &owner) noexcept
 
template<class Callable , class Owner >
void setVariableLengthFieldToNull (Callable callable, SchemaVersion since, Owner &owner) noexcept
 
template<class Group , class Callable , class Owner >
void resetGroup (Callable callable, SchemaVersion since, Owner &owner)
 
template<class Group , class Callable , class Owner >
Group getGroup (Callable callable, Owner &owner) const noexcept
 
template<class Group , class Callable , class Owner >
Group getGroup (Callable callable, SchemaVersion since, Owner &owner) const noexcept
 
template<class Group , class Callable , class Owner >
Group constructGroup (Callable callable, typename Group::Size length, SchemaVersion since, Owner &owner)
 
template<class Group , class Callable , class Owner >
Group constructGroup (Callable callable, typename Group::Size length, Owner &owner)
 
template<class Group , class Callable , class Owner >
Group setupGroup (Callable callable, typename Group::Size length, SchemaVersion since, Owner &owner)
 
template<class Group , class Callable , class Owner >
Group setupGroup (Callable callable, typename Group::Size length, Owner &owner)
 
- Protected Member Functions inherited from SbeFields< Messaging::SbeMessage, MessageSize >
 SbeFields ()
 
 ~SbeFields ()
 
- Protected Member Functions inherited from BinaryBlock< Messaging::SbeMessage, MessageSize >
 BinaryBlock ()
 
 ~BinaryBlock ()
 
Value ordinary (MessageSize offset) const noexcept
 
bool ordinary (Value &value, MessageSize offset, NullValue null) const noexcept
 
bool ordinary (Value &value, MessageSize offset, NullValue null, SchemaVersion since) const noexcept
 
Enumeration::Enum enumeration (MessageSize offset) const noexcept
 
bool enumeration (typename Enumeration::Enum &value, MessageSize offset, NullValue null) const noexcept
 
bool enumeration (typename Enumeration::Enum &value, MessageSize offset, NullValue null, SchemaVersion since) const noexcept
 
Value decimal (MessageSize offset) const noexcept
 
bool decimal (Value &value, MessageSize offset, NullValue null) const noexcept
 
bool decimal (Value &value, MessageSize offset, NullValue null, SchemaVersion since) const noexcept
 
StrRef fixedStr (MessageSize offset) const noexcept
 
bool fixedStr (StrRef &value, MessageSize offset) const noexcept
 
bool fixedStr (StrRef &value, MessageSize offset, SchemaVersion since) const noexcept
 
- Static Protected Member Functions inherited from SbeMessage
static constexpr MessageSize getMaxMessageSize () noexcept
 

Detailed Description

Definition at line 1826 of file Messages.h.

Member Typedef Documentation

Used template schema.

Definition at line 1831 of file Messages.h.

This type alias.

Definition at line 1834 of file Messages.h.

Member Enumeration Documentation

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 

Definition at line 1837 of file Messages.h.

Constructor & Destructor Documentation

EstablishmentAck504 ( )
inline

Initializes a blank instance.

Definition at line 1840 of file Messages.h.

EstablishmentAck504 ( void *  data,
EncodedLength  length,
SchemaVersion  version = Schema::Version 
)
inline

Initializes an instance over the given memory block.

Definition at line 1843 of file Messages.h.

EstablishmentAck504 ( void *  data,
EncodedLength  length,
NoFieldsInit  ,
SchemaVersion  version = Schema::Version 
)
inline

Initializes an instance over the given memory block With no variable-length fields initialization It is assumed that the user does such an initialization manually.

Definition at line 1858 of file Messages.h.

EstablishmentAck504 ( void *  data,
EncodedLength  length,
NoInit   
)
inline

Creates an instance over the given memory block.

Definition at line 1872 of file Messages.h.

EstablishmentAck504 ( const SbeMessage message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 1883 of file Messages.h.

EstablishmentAck504 ( void *  data,
EncodedLength  length,
NoInit  ,
NoCheck   
)
inlinenoexcept

Creates an instance over the given memory block.

Performs no checks.

Definition at line 1894 of file Messages.h.

Member Function Documentation

static constexpr BlockLength blockLength ( SchemaVersion  version)
inlinestaticnoexcept

Size of message body in bytes.

Definition at line 2151 of file Messages.h.

EncodedLength calculateBinarySize ( ) const
inlinenoexcept
Returns
the size occupied by the message.

Definition at line 2242 of file Messages.h.

static constexpr const Char* className ( )
inlinestatic
Returns
class name.

Definition at line 2208 of file Messages.h.

bool faultToleranceIndicator ( FTI::Enum value) const
inlinenoexcept

Indicates whether the connection is primary or backup.

Definition at line 2066 of file Messages.h.

static constexpr StrRef fixType ( )
inlinestaticnoexcept

FIX message type.

Definition at line 2217 of file Messages.h.

static constexpr UInt64 getMaxMessageSize ( UInt8  )
inlinestaticnoexcept

Maximal message size.

Definition at line 2177 of file Messages.h.

static constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion  version)
inlinestatic

Minimal variable fields size (when variable-length fields are empty).

Definition at line 2165 of file Messages.h.

UInt16 keepAliveInterval ( ) const
inlinenoexcept

The longest time in milliseconds the customer or CME could remain silent before sending a keep alive message.

Definition at line 2014 of file Messages.h.

static constexpr BlockLength minimalBlockLength ( SchemaVersion  version)
inlinestaticnoexcept

Minimal size of message body in bytes.

Definition at line 2139 of file Messages.h.

UInt32 nextSeqNo ( ) const
inlinenoexcept

Next expected message sequence number.

Definition at line 1949 of file Messages.h.

UInt32 previousSeqNo ( ) const
inlinenoexcept

Refers to the SeqNum sent in the previous message before this one from CME.

Definition at line 1970 of file Messages.h.

UInt64 previousUUId ( ) const
inlinenoexcept

Refers to the UUID sent in the previous message before this one from CME.

Definition at line 1992 of file Messages.h.

UInt64 requestTimestamp ( ) const
inlinenoexcept

Matches Establish.RequestTimestamp.

Definition at line 1929 of file Messages.h.

ThisType& reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 2193 of file Messages.h.

ThisType& resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 2186 of file Messages.h.

bool secretKeySecureIdExpiration ( UInt16 value) const
inlinenoexcept

This indicates in how many days the HMAC secret key will expire.

Definition at line 2036 of file Messages.h.

ThisType& setFaultToleranceIndicator ( FTI::Enum  value)
inlinenoexcept

Indicates whether the connection is primary or backup.

Definition at line 2075 of file Messages.h.

ThisType& setFaultToleranceIndicatorToNull ( )
inlinenoexcept

Definition at line 2084 of file Messages.h.

ThisType& setKeepAliveInterval ( UInt16  value)
inlinenoexcept

The longest time in milliseconds the customer or CME could remain silent before sending a keep alive message.

Definition at line 2024 of file Messages.h.

ThisType& setNextSeqNo ( UInt32  value)
inlinenoexcept

Next expected message sequence number.

Definition at line 1958 of file Messages.h.

ThisType& setPreviousSeqNo ( UInt32  value)
inlinenoexcept

Refers to the SeqNum sent in the previous message before this one from CME.

Definition at line 1980 of file Messages.h.

ThisType& setPreviousUUId ( UInt64  value)
inlinenoexcept

Refers to the UUID sent in the previous message before this one from CME.

Definition at line 2002 of file Messages.h.

ThisType& setRequestTimestamp ( UInt64  value)
inlinenoexcept

Matches Establish.RequestTimestamp.

Definition at line 1938 of file Messages.h.

ThisType& setSecretKeySecureIdExpiration ( UInt16  value)
inlinenoexcept

This indicates in how many days the HMAC secret key will expire.

Definition at line 2046 of file Messages.h.

ThisType& setSecretKeySecureIdExpirationToNull ( )
inlinenoexcept

Definition at line 2055 of file Messages.h.

ThisType& setSplitMsg ( SplitMsg::Enum  value)
inlinenoexcept

Indicates whether a message was delayed as a result of being split among multiple packets (0) or if a message was delayed as a result of TCP re-transmission (1) or if a complete message was delayed due to a previously submitted split or out of order message (2).

If absent then the message was not delayed and was neither split nor received out of order.

Definition at line 2116 of file Messages.h.

ThisType& setSplitMsgToNull ( )
inlinenoexcept

Definition at line 2125 of file Messages.h.

ThisType& setUuId ( UInt64  value)
inlinenoexcept

Matches Establish.UUID.

Definition at line 1918 of file Messages.h.

bool splitMsg ( SplitMsg::Enum value) const
inlinenoexcept

Indicates whether a message was delayed as a result of being split among multiple packets (0) or if a message was delayed as a result of TCP re-transmission (1) or if a complete message was delayed due to a previously submitted split or out of order message (2).

If absent then the message was not delayed and was neither split nor received out of order.

Definition at line 2101 of file Messages.h.

const void* tail ( ) const
inlinenoexcept
Returns
the end of the message.

Definition at line 2229 of file Messages.h.

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

Definition at line 249 of file MessageSerialization.h.

UInt64 uuId ( ) const
inlinenoexcept

Matches Establish.UUID.

Definition at line 1909 of file Messages.h.


The documentation for this struct was generated from the following files: