NegotiationResponse501 Struct Reference

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

Public Member Functions
	NegotiationResponse501 ()=default
	NegotiationResponse501 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
	NegotiationResponse501 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
	NegotiationResponse501 (void *data, EncodedLength length, NoInit)
	NegotiationResponse501 (const SbeMessage &message)
	NegotiationResponse501 (void *data, EncodedLength length, NoInit, NoCheck) noexcept
UInt64	uuId () const noexcept
ThisType &	setUuId (UInt64 value) noexcept
UInt64	requestTimestamp () const noexcept
ThisType &	setRequestTimestamp (UInt64 value) noexcept
bool	secretKeySecureIdExpiration (UInt16 &value) const noexcept
ThisType &	setSecretKeySecureIdExpiration (UInt16 value) noexcept
ThisType &	setSecretKeySecureIdExpirationToNull () noexcept
bool	faultToleranceIndicator (FTI::Enum &value) const noexcept
ThisType &	setFaultToleranceIndicator (FTI::Enum value) noexcept
ThisType &	setFaultToleranceIndicatorToNull () noexcept
bool	splitMsg (SplitMsg::Enum &value) const noexcept
ThisType &	setSplitMsg (SplitMsg::Enum value) noexcept
ThisType &	setSplitMsgToNull () noexcept
UInt32	previousSeqNo () const noexcept
ThisType &	setPreviousSeqNo (UInt32 value) noexcept
UInt64	previousUUId () const noexcept
ThisType &	setPreviousUUId (UInt64 value) noexcept
bool	environmentIndicator (UInt8 &value) const noexcept
ThisType &	setEnvironmentIndicator (UInt8 value)
ThisType &	setEnvironmentIndicatorToNull ()
StrRef	credentials () const noexcept
ThisType &	setCredentials (StrRef value)
ThisType &	resetVariableFields () noexcept
ThisType &	reset () 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::SbeMessage &	container () 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 StrRef	serverFlow () 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 StrRef	className () noexcept
static constexpr StrRef	fixType () noexcept

Additional Inherited Members
Protected Types inherited from SbeMessage
typedef SbeGroupList< MessageSize >	GroupList
typedef SbeVariableLengthFieldList< MessageSize >	VariableLengthFieldList
Protected Member Functions inherited from SbeMessage
SbeMessage &	version (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 ()=default
	~SbeFields ()=default
Protected Member Functions inherited from BinaryBlock< Messaging::SbeMessage, MessageSize >
	BinaryBlock ()=default
	~BinaryBlock ()=default
Value	ordinary (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 429 of file Messages.h.

Member Typedef Documentation

Schema

typedef SchemaTraits Schema

Used template schema.

Definition at line 434 of file Messages.h.

ThisType

typedef NegotiationResponse501 ThisType

This type alias.

Definition at line 437 of file Messages.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId	501

Definition at line 440 of file Messages.h.

Constructor & Destructor Documentation

NegotiationResponse501() [1/6]

NegotiationResponse501 ( )

default

Initializes a blank instance.

NegotiationResponse501() [2/6]

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

inline

Initializes an instance over the given memory block.

Definition at line 446 of file Messages.h.

NegotiationResponse501() [3/6]

NegotiationResponse501 ( 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 461 of file Messages.h.

NegotiationResponse501() [4/6]

NegotiationResponse501 ( void * data, EncodedLength length, NoInit  )

inline

Creates an instance over the given memory block.

Definition at line 475 of file Messages.h.

NegotiationResponse501() [5/6]

NegotiationResponse501 ( const SbeMessage & message )

inlineexplicit

Creates an instance over the given SBE message.

Definition at line 486 of file Messages.h.

NegotiationResponse501() [6/6]

NegotiationResponse501 ( void * data, EncodedLength length, NoInit , NoCheck  )

inlinenoexcept

Creates an instance over the given memory block.

Performs no checks.

Definition at line 497 of file Messages.h.

Member Function Documentation

blockLength()

constexpr BlockLength blockLength ( SchemaVersion version )

inlinestaticconstexprnoexcept

Size of message body in bytes.

Definition at line 753 of file Messages.h.

calculateBinarySize()

EncodedLength calculateBinarySize ( ) const

inlinenoexcept

Returns

the size occupied by the message.

Definition at line 840 of file Messages.h.

className()

constexpr StrRef className ( )

inlinestaticconstexprnoexcept

Returns

class name.

Definition at line 811 of file Messages.h.

credentials()

StrRef credentials ( ) const

inlinenoexcept

Not used and will be set to 0.

Definition at line 720 of file Messages.h.

environmentIndicator()

bool environmentIndicator ( UInt8 & value ) const

inlinenoexcept

Provides customers with the information of the type of environment they are connecting to.

Definition at line 690 of file Messages.h.

faultToleranceIndicator()

bool faultToleranceIndicator ( FTI::Enum & value ) const

inlinenoexcept

Indicates whether the connection is primary or backup.

Definition at line 585 of file Messages.h.

fixType()

constexpr StrRef fixType ( )

inlinestaticconstexprnoexcept

FIX message type.

Definition at line 820 of file Messages.h.

getMaxMessageSize()

constexpr UInt64 getMaxMessageSize ( UInt8 )

inlinestaticconstexprnoexcept

Maximal message size.

Definition at line 778 of file Messages.h.

getMinimalVariableFieldsSize()

constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version )

inlinestaticconstexpr

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

Definition at line 766 of file Messages.h.

minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version )

inlinestaticconstexprnoexcept

Minimal size of message body in bytes.

Definition at line 741 of file Messages.h.

previousSeqNo()

UInt32 previousSeqNo ( ) const

inlinenoexcept

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

Definition at line 650 of file Messages.h.

previousUUId()

UInt64 previousUUId ( ) const

inlinenoexcept

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

Definition at line 670 of file Messages.h.

requestTimestamp()

UInt64 requestTimestamp ( ) const

inlinenoexcept

Matches Negotiate.RequestTimestamp.

Definition at line 539 of file Messages.h.

reset()

ThisType & reset ( )

inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 792 of file Messages.h.

resetVariableFields()

ThisType & resetVariableFields ( )

inlinenoexcept

Reset all variable-length fields if any.

Definition at line 785 of file Messages.h.

secretKeySecureIdExpiration()

bool secretKeySecureIdExpiration ( UInt16 & value ) const

inlinenoexcept

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

Definition at line 558 of file Messages.h.

serverFlow()

constexpr StrRef serverFlow ( )

inlinestaticconstexprnoexcept

Constant value representing type of flow from CME to customer.

Definition at line 514 of file Messages.h.

setCredentials()

ThisType & setCredentials ( StrRef value )

inline

Not used and will be set to 0.

Definition at line 728 of file Messages.h.

setEnvironmentIndicator()

ThisType & setEnvironmentIndicator ( UInt8 value )

inline

Provides customers with the information of the type of environment they are connecting to.

Definition at line 700 of file Messages.h.

setEnvironmentIndicatorToNull()

ThisType & setEnvironmentIndicatorToNull ( )

inline

Definition at line 709 of file Messages.h.

setFaultToleranceIndicator()

ThisType & setFaultToleranceIndicator ( FTI::Enum value )

inlinenoexcept

Indicates whether the connection is primary or backup.

Definition at line 593 of file Messages.h.

setFaultToleranceIndicatorToNull()

ThisType & setFaultToleranceIndicatorToNull ( )

inlinenoexcept

Definition at line 601 of file Messages.h.

setPreviousSeqNo()

ThisType & setPreviousSeqNo ( UInt32 value )

inlinenoexcept

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

Definition at line 659 of file Messages.h.

setPreviousUUId()

ThisType & setPreviousUUId ( UInt64 value )

inlinenoexcept

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

Definition at line 679 of file Messages.h.

setRequestTimestamp()

ThisType & setRequestTimestamp ( UInt64 value )

inlinenoexcept

Matches Negotiate.RequestTimestamp.

Definition at line 547 of file Messages.h.

setSecretKeySecureIdExpiration()

ThisType & setSecretKeySecureIdExpiration ( UInt16 value )

inlinenoexcept

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

Definition at line 567 of file Messages.h.

setSecretKeySecureIdExpirationToNull()

ThisType & setSecretKeySecureIdExpirationToNull ( )

inlinenoexcept

Definition at line 575 of file Messages.h.

setSplitMsg()

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

setSplitMsgToNull()

ThisType & setSplitMsgToNull ( )

inlinenoexcept

Definition at line 639 of file Messages.h.

setUuId()

ThisType & setUuId ( UInt64 value )

inlinenoexcept

Matches Negotiate.UUID.

Definition at line 529 of file Messages.h.

splitMsg()

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

tail()

const void * tail ( ) const

inlinenoexcept

Returns

the end of the message.

Definition at line 831 of file Messages.h.

toString()

std::string toString ( ) const

inline

Returns

a human-readable presentation.

Definition at line 111 of file MessageSerialization.h.

uuId()

UInt64 uuId ( ) const

inlinenoexcept

Matches Negotiate.UUID.

Definition at line 521 of file Messages.h.