OnixS C++ B3 BOE Binary Order Entry  1.2.0
API Documentation
EstablishAck5 Struct Reference

#include <OnixS/B3/BOE/messaging/Messages.h>

Public Types

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

Public Member Functions

 EstablishAck5 ()=default
 
 EstablishAck5 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
 
 EstablishAck5 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
 
 EstablishAck5 (void *data, EncodedLength length, NoInit)
 
 EstablishAck5 (const SbeMessage &message)
 
 EstablishAck5 (void *data, EncodedLength length, NoInit, NoCheck) noexcept
 
SessionID sessionId () const noexcept
 
ThisTypesetSessionId (SessionID value) noexcept
 
SessionVerID sessionVerId () const noexcept
 
ThisTypesetSessionVerId (SessionVerID value) noexcept
 
UTCTimestampNanos requestTimestamp () const noexcept
 
ThisTypesetRequestTimestamp (UTCTimestampNanos value) noexcept
 
DeltaInMillis keepAliveInterval () const noexcept
 
ThisTypesetKeepAliveInterval (DeltaInMillis value) noexcept
 
SeqNum nextSeqNo () const noexcept
 
ThisTypesetNextSeqNo (SeqNum value) noexcept
 
SeqNum lastIncomingSeqNo () const noexcept
 
ThisTypesetLastIncomingSeqNo (SeqNum value) 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 (MessageSizeoffset) noexcept
 
void setOrdinary (MessageSizeoffset, FieldValue value) noexcept
 
void setOrdinary (MessageSizeoffset, FieldValue value, SchemaVersion since)
 
void setEnumeration (MessageSizeoffset, typename Enumeration::Enum value) noexcept
 
void setEnumeration (MessageSizeoffset, typename Enumeration::Enum value, SchemaVersion since)
 
void setFixedStr (MessageSizeoffset, StrRef value) noexcept
 
void setFixedStr (MessageSizeoffset, StrRef value, SchemaVersion since)
 

Static Public Member Functions

static constexpr MessageType::Enum messageType () noexcept
 
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)
 
template<typename DATA >
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 ()=default
 
 ~SbeFields ()=default
 
- Protected Member Functions inherited from BinaryBlock< Messaging::SbeMessage, MessageSize >
 BinaryBlock ()=default
 
 ~BinaryBlock ()=default
 
Value ordinary (MessageSizeoffset) const noexcept
 
bool ordinary (Value &value, MessageSizeoffset, NullValue null) const noexcept
 
bool ordinary (Value &value, MessageSizeoffset, NullValue null, SchemaVersion since) const noexcept
 
const Value & accessOrdinary (MessageSizeoffset) const noexcept
 
Value & accessOrdinary (MessageSizeoffset) noexcept
 
Enumeration::Enum enumeration (MessageSizeoffset) const noexcept
 
bool enumeration (typename Enumeration::Enum &value, MessageSizeoffset, NullValue null) const noexcept
 
bool enumeration (typename Enumeration::Enum &value, MessageSizeoffset, NullValue null, SchemaVersion since) const noexcept
 
Value decimal (MessageSizeoffset) const noexcept
 
bool decimal (Value &value, MessageSizeoffset, NullValue null) const noexcept
 
bool decimal (Value &value, MessageSizeoffset, NullValue null, SchemaVersion since) const noexcept
 
StrRef fixedStr (MessageSizeoffset) const noexcept
 
bool fixedStr (StrRef &value, MessageSizeoffset) const noexcept
 
bool fixedStr (StrRef &value, MessageSizeoffset, SchemaVersion since) const noexcept
 
- Static Protected Member Functions inherited from SbeMessage
static constexpr MessageSize getMaxMessageSize () noexcept
 

Detailed Description

Definition at line 1782 of file Messages.h.

Member Typedef Documentation

Used template schema.

Definition at line 1787 of file Messages.h.

This type alias.

Definition at line 1790 of file Messages.h.

Member Enumeration Documentation

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 

Definition at line 1793 of file Messages.h.

Constructor & Destructor Documentation

EstablishAck5 ( )
default

Initializes a blank instance.

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

Initializes an instance over the given memory block.

Definition at line 1799 of file Messages.h.

EstablishAck5 ( 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 1814 of file Messages.h.

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

Creates an instance over the given memory block.

Definition at line 1828 of file Messages.h.

EstablishAck5 ( const SbeMessage message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 1839 of file Messages.h.

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

Creates an instance over the given memory block.

Performs no checks.

Definition at line 1850 of file Messages.h.

Member Function Documentation

static constexpr BlockLength blockLength ( SchemaVersion  version)
inlinestaticnoexcept

Size of message body in bytes.

Definition at line 2031 of file Messages.h.

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

Definition at line 2118 of file Messages.h.

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

Definition at line 2084 of file Messages.h.

static constexpr StrRef fixType ( )
inlinestaticnoexcept

FIX message type.

Definition at line 2093 of file Messages.h.

static constexpr UInt64 getMaxMessageSize ( UInt8  )
inlinestaticnoexcept

Maximal message size.

Definition at line 2057 of file Messages.h.

static constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion  version)
inlinestatic

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

Definition at line 2045 of file Messages.h.

DeltaInMillis keepAliveInterval ( ) const
inlinenoexcept

Longest time in milliseconds the initiator should remain silent before sending Sequence message.

Definition at line 1947 of file Messages.h.

SeqNum lastIncomingSeqNo ( ) const
inlinenoexcept

Indicates the application sequence number of the last application message received by the server from the client.

At the start of a session, default value is 0 (zero).

Definition at line 1993 of file Messages.h.

static constexpr MessageType::Enum messageType ( )
inlinestaticnoexcept

Message type = EstablishAck.

Definition at line 1866 of file Messages.h.

static constexpr BlockLength minimalBlockLength ( SchemaVersion  version)
inlinestaticnoexcept

Minimal size of message body in bytes.

Definition at line 2019 of file Messages.h.

SeqNum nextSeqNo ( ) const
inlinenoexcept

The next application sequence number to be produced by the gateway.

Definition at line 1969 of file Messages.h.

UTCTimestampNanos requestTimestamp ( ) const
inlinenoexcept

Matches Negotiate timestamp.

Definition at line 1926 of file Messages.h.

ThisType& reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 2073 of file Messages.h.

ThisType& resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 2066 of file Messages.h.

SessionID sessionId ( ) const
inlinenoexcept

Message type = EstablishAck.

Client connection identification on the gateway assigned by B3.

Definition at line 1877 of file Messages.h.

SessionVerID sessionVerId ( ) const
inlinenoexcept

Session version identification: unique identification of a sequence of messages to be transmitted to/from B3´s gateways associated with given SessionId.

Need to be incremented each time Negotiate message is sent to gateway.

Definition at line 1902 of file Messages.h.

ThisType& setKeepAliveInterval ( DeltaInMillis  value)
inlinenoexcept

Longest time in milliseconds the initiator should remain silent before sending Sequence message.

Definition at line 1957 of file Messages.h.

ThisType& setLastIncomingSeqNo ( SeqNum  value)
inlinenoexcept

Indicates the application sequence number of the last application message received by the server from the client.

At the start of a session, default value is 0 (zero).

Definition at line 2005 of file Messages.h.

ThisType& setNextSeqNo ( SeqNum  value)
inlinenoexcept

The next application sequence number to be produced by the gateway.

Definition at line 1979 of file Messages.h.

ThisType& setRequestTimestamp ( UTCTimestampNanos  value)
inlinenoexcept

Matches Negotiate timestamp.

Definition at line 1935 of file Messages.h.

ThisType& setSessionId ( SessionID  value)
inlinenoexcept

Client connection identification on the gateway assigned by B3.

Definition at line 1887 of file Messages.h.

ThisType& setSessionVerId ( SessionVerID  value)
inlinenoexcept

Session version identification: unique identification of a sequence of messages to be transmitted to/from B3´s gateways associated with given SessionId.

Need to be incremented each time Negotiate message is sent to gateway.

Definition at line 1915 of file Messages.h.

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

Definition at line 2105 of file Messages.h.

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

Definition at line 246 of file MessageSerialization.h.


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