OnixS C++ B3 BOE Binary Order Entry 1.3.0
API Documentation
Loading...
Searching...
No Matches
NegotiateResponse2 Struct Reference

Public Types

enum  
typedef SchemaTraits Schema
typedef NegotiateResponse2 ThisType
Public Types inherited from SbeMessage
typedef MessageSize EncodedLength
typedef MessageSize BlockLength

Public Member Functions

 NegotiateResponse2 ()=default
 NegotiateResponse2 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
 NegotiateResponse2 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
 NegotiateResponse2 (void *data, EncodedLength length, NoInit)
 NegotiateResponse2 (const SbeMessage &message)
 NegotiateResponse2 (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
Firm enteringFirm () const noexcept
ThisTypesetEnteringFirm (Firm value) noexcept
bool semanticVersion (Version &value) const noexcept
ThisTypesetSemanticVersion (Version value)
ThisTypesetSemanticVersionToNull ()
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 setEnumeration (MessageSize offset, typename Enumeration::Enum value) noexcept
void setFixedStr (MessageSize offset, StrRef value) noexcept

Static Public Member Functions

static constexpr MessageType::Enum messageType () noexcept
static constexpr FlowType::Enum serverFlow () noexcept
static constexpr FlowType::Enum clientFlow () 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 (MessageSize offset) const noexcept
const Value & accessOrdinary (MessageSize offset) const noexcept
Enumeration::Enum enumeration (MessageSize offset) const noexcept
Value decimal (MessageSize offset) const noexcept
StrRef fixedStr (MessageSize offset) const noexcept
Static Protected Member Functions inherited from SbeMessage
static constexpr MessageSize getMaxMessageSize () noexcept

Detailed Description

Definition at line 590 of file Messages.h.

Member Typedef Documentation

◆ Schema

Used template schema.

Definition at line 595 of file Messages.h.

◆ ThisType

This type alias.

Definition at line 598 of file Messages.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 

Definition at line 601 of file Messages.h.

Constructor & Destructor Documentation

◆ NegotiateResponse2() [1/6]

NegotiateResponse2 ( )
default

Initializes a blank instance.

◆ NegotiateResponse2() [2/6]

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

Initializes an instance over the given memory block.

Definition at line 607 of file Messages.h.

◆ NegotiateResponse2() [3/6]

NegotiateResponse2 ( 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 622 of file Messages.h.

◆ NegotiateResponse2() [4/6]

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

Creates an instance over the given memory block.

Definition at line 636 of file Messages.h.

◆ NegotiateResponse2() [5/6]

NegotiateResponse2 ( const SbeMessage & message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 647 of file Messages.h.

◆ NegotiateResponse2() [6/6]

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

Creates an instance over the given memory block.

Performs no checks.

Definition at line 658 of file Messages.h.

Member Function Documentation

◆ blockLength()

constexpr BlockLength blockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Size of message body in bytes.

Definition at line 846 of file Messages.h.

◆ calculateBinarySize()

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

Definition at line 938 of file Messages.h.

◆ className()

constexpr const Char * className ( )
inlinestaticconstexpr
Returns
class name.

Definition at line 904 of file Messages.h.

◆ clientFlow()

constexpr FlowType::Enum clientFlow ( )
inlinestaticconstexprnoexcept

Type of flow from client to server.

It is a constant value = recoverable. Type of flow from client to server. It is a constant value = idempotent.

Definition at line 769 of file Messages.h.

◆ enteringFirm()

Firm enteringFirm ( ) const
inlinenoexcept

Type of flow from client to server.

It is a constant value = idempotent. Identifies the broker firm that will enter orders.

Definition at line 780 of file Messages.h.

◆ fixType()

constexpr StrRef fixType ( )
inlinestaticconstexprnoexcept

FIX message type.

Definition at line 913 of file Messages.h.

◆ getMaxMessageSize()

constexpr UInt64 getMaxMessageSize ( UInt8 )
inlinestaticconstexprnoexcept

Maximal message size.

Definition at line 872 of file Messages.h.

◆ getMinimalVariableFieldsSize()

constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version)
inlinestaticconstexpr

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

Definition at line 860 of file Messages.h.

◆ messageType()

constexpr MessageType::Enum messageType ( )
inlinestaticconstexprnoexcept

Message type = NegotiateResponse.

Definition at line 674 of file Messages.h.

◆ minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Minimal size of message body in bytes.

Definition at line 833 of file Messages.h.

◆ requestTimestamp()

UTCTimestampNanos requestTimestamp ( ) const
inlinenoexcept

Matches Negotiate timestamp.

Definition at line 734 of file Messages.h.

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 888 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 881 of file Messages.h.

◆ semanticVersion()

bool semanticVersion ( Version & value) const
inlinenoexcept

Identifies the semantic version of the schema used in this session.

Definition at line 801 of file Messages.h.

◆ serverFlow()

constexpr FlowType::Enum serverFlow ( )
inlinestaticconstexprnoexcept

Type of flow from client to server.

It is a constant value = recoverable.

Definition at line 756 of file Messages.h.

◆ sessionId()

SessionID sessionId ( ) const
inlinenoexcept

Message type = NegotiateResponse.

Client connection identification on the gateway assigned by B3.

Definition at line 685 of file Messages.h.

◆ sessionVerId()

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 710 of file Messages.h.

◆ setEnteringFirm()

ThisType & setEnteringFirm ( Firm value)
inlinenoexcept

Identifies the broker firm that will enter orders.

Definition at line 789 of file Messages.h.

◆ setRequestTimestamp()

ThisType & setRequestTimestamp ( UTCTimestampNanos value)
inlinenoexcept

Matches Negotiate timestamp.

Definition at line 743 of file Messages.h.

◆ setSemanticVersion()

ThisType & setSemanticVersion ( Version value)
inline

Identifies the semantic version of the schema used in this session.

Definition at line 812 of file Messages.h.

◆ setSemanticVersionToNull()

ThisType & setSemanticVersionToNull ( )
inline

Definition at line 821 of file Messages.h.

◆ setSessionId()

ThisType & setSessionId ( SessionID value)
inlinenoexcept

Client connection identification on the gateway assigned by B3.

Definition at line 695 of file Messages.h.

◆ setSessionVerId()

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 723 of file Messages.h.

◆ tail()

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

Definition at line 925 of file Messages.h.

◆ toString()

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

Definition at line 111 of file MessageSerialization.h.