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

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

Public Types

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

Public Member Functions

 Negotiate500 ()
 
 Negotiate500 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
 
 Negotiate500 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
 
 Negotiate500 (void *data, EncodedLength length, NoInit)
 
 Negotiate500 (const SbeMessage &message)
 
 Negotiate500 (void *data, EncodedLength length, NoInit, NoCheck) noexcept
 
StrRef hmacSignature () const noexcept
 
ThisTypesetHmacSignature (StrRef value) noexcept
 
StrRef accessKeyId () const noexcept
 
ThisTypesetAccessKeyId (StrRef value) noexcept
 
UInt64 uuId () const noexcept
 
ThisTypesetUuId (UInt64 value) noexcept
 
UInt64 requestTimestamp () const noexcept
 
ThisTypesetRequestTimestamp (UInt64 value) noexcept
 
StrRef session () const noexcept
 
ThisTypesetSession (StrRef value) noexcept
 
StrRef firm () const noexcept
 
ThisTypesetFirm (StrRef value) noexcept
 
StrRef credentials () const noexcept
 
ThisTypesetCredentials (StrRef value)
 
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 StrRef customerFlow () noexcept
 
static constexpr StrRef hmacVersion () 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)
 
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 33 of file Messages.h.

Member Typedef Documentation

Used template schema.

Definition at line 38 of file Messages.h.

This type alias.

Definition at line 41 of file Messages.h.

Member Enumeration Documentation

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 

Definition at line 44 of file Messages.h.

Constructor & Destructor Documentation

Negotiate500 ( )
inline

Initializes a blank instance.

Definition at line 47 of file Messages.h.

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

Initializes an instance over the given memory block.

Definition at line 50 of file Messages.h.

Negotiate500 ( 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 65 of file Messages.h.

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

Creates an instance over the given memory block.

Definition at line 79 of file Messages.h.

Negotiate500 ( const SbeMessage message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 90 of file Messages.h.

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

Creates an instance over the given memory block.

Performs no checks.

Definition at line 101 of file Messages.h.

Member Function Documentation

StrRef accessKeyId ( ) const
inlinenoexcept

Contains the AccessKeyID assigned to this session on this port.

Definition at line 160 of file Messages.h.

static constexpr BlockLength blockLength ( SchemaVersion  version)
inlinestaticnoexcept

Size of message body in bytes.

Definition at line 309 of file Messages.h.

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

Definition at line 393 of file Messages.h.

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

Definition at line 362 of file Messages.h.

StrRef credentials ( ) const
inlinenoexcept

Not used and will be set to 0.

Definition at line 273 of file Messages.h.

static constexpr StrRef customerFlow ( )
inlinestaticnoexcept

Constant value representing type of flow from customer to CME.

Definition at line 119 of file Messages.h.

StrRef firm ( ) const
inlinenoexcept

Firm ID.

Definition at line 251 of file Messages.h.

static constexpr StrRef fixType ( )
inlinestaticnoexcept

FIX message type.

Definition at line 371 of file Messages.h.

static constexpr UInt64 getMaxMessageSize ( UInt8  )
inlinestaticnoexcept

Maximal message size.

Definition at line 335 of file Messages.h.

static constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion  version)
inlinestatic

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

Definition at line 323 of file Messages.h.

StrRef hmacSignature ( ) const
inlinenoexcept

Contains the HMAC signature.

Definition at line 137 of file Messages.h.

static constexpr StrRef hmacVersion ( )
inlinestaticnoexcept

Constant value representing CME HMAC version.

Definition at line 129 of file Messages.h.

static constexpr BlockLength minimalBlockLength ( SchemaVersion  version)
inlinestaticnoexcept

Minimal size of message body in bytes.

Definition at line 297 of file Messages.h.

UInt64 requestTimestamp ( ) const
inlinenoexcept

Time of request; recommended to use timestamp as number of nanoseconds since epoch (Jan 1, 1970).

Definition at line 208 of file Messages.h.

ThisType& reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 351 of file Messages.h.

ThisType& resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 343 of file Messages.h.

StrRef session ( ) const
inlinenoexcept

Session ID.

Definition at line 229 of file Messages.h.

ThisType& setAccessKeyId ( StrRef  value)
inlinenoexcept

Contains the AccessKeyID assigned to this session on this port.

Definition at line 171 of file Messages.h.

ThisType& setCredentials ( StrRef  value)
inline

Not used and will be set to 0.

Definition at line 282 of file Messages.h.

ThisType& setFirm ( StrRef  value)
inlinenoexcept

Firm ID.

Definition at line 261 of file Messages.h.

ThisType& setHmacSignature ( StrRef  value)
inlinenoexcept

Contains the HMAC signature.

Definition at line 147 of file Messages.h.

ThisType& setRequestTimestamp ( UInt64  value)
inlinenoexcept

Time of request; recommended to use timestamp as number of nanoseconds since epoch (Jan 1, 1970).

Definition at line 218 of file Messages.h.

ThisType& setSession ( StrRef  value)
inlinenoexcept

Session ID.

Definition at line 239 of file Messages.h.

ThisType& setUuId ( UInt64  value)
inlinenoexcept

Session Identifier defined as type long (uInt64); recommended to use timestamp as number of microseconds since epoch (Jan 1, 1970).

Definition at line 196 of file Messages.h.

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

Definition at line 383 of file Messages.h.

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

Definition at line 64 of file MessageSerialization.h.

UInt64 uuId ( ) const
inlinenoexcept

Session Identifier defined as type long (uInt64); recommended to use timestamp as number of microseconds since epoch (Jan 1, 1970).

Definition at line 185 of file Messages.h.


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