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

Public Member Functions
	Negotiate1 ()=default
	Negotiate1 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
	Negotiate1 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
	Negotiate1 (void *data, EncodedLength length, NoInit)
	Negotiate1 (const SbeMessage &message)
	Negotiate1 (void *data, EncodedLength length, NoInit, NoCheck) noexcept
SessionID	sessionId () const noexcept
ThisType &	setSessionId (SessionID value) noexcept
SessionVerID	sessionVerId () const noexcept
ThisType &	setSessionVerId (SessionVerID value) noexcept
UTCTimestampNanos	timestamp () const noexcept
ThisType &	setTimestamp (UTCTimestampNanos value) noexcept
Firm	enteringFirm () const noexcept
ThisType &	setEnteringFirm (Firm value) noexcept
bool	onbehalfFirm (FirmOptional &value) const noexcept
ThisType &	setOnbehalfFirm (FirmOptional value) noexcept
ThisType &	setOnbehalfFirmToNull () noexcept
StrRef	credentials () const noexcept
StrRef	clientIP () const noexcept
StrRef	clientAppName () const noexcept
StrRef	clientAppVersion () const noexcept
ThisType &	setCredentials (StrRef value)
ThisType &	setClientIP (StrRef value)
ThisType &	setClientAppName (StrRef value)
ThisType &	setClientAppVersion (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 MessageType::Enum	messageType () 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 Char *	className ()
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)
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 33 of file Messages.h.

Member Typedef Documentation

◆ Schema

typedef SchemaTraits Schema

Used template schema.

Definition at line 38 of file Messages.h.

◆ ThisType

typedef Negotiate1 ThisType

This type alias.

Definition at line 41 of file Messages.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId	1

Definition at line 44 of file Messages.h.

Constructor & Destructor Documentation

◆ Negotiate1() [1/6]

Negotiate1 ( )

default

Initializes a blank instance.

◆ Negotiate1() [2/6]

Negotiate1	(	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.

◆ Negotiate1() [3/6]

Negotiate1	(	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.

◆ Negotiate1() [4/6]

Negotiate1	(	void *	data,
		EncodedLength	length,
		NoInit	)

inline

Creates an instance over the given memory block.

Definition at line 79 of file Messages.h.

◆ Negotiate1() [5/6]

Negotiate1 ( const SbeMessage & message )

inlineexplicit

Creates an instance over the given SBE message.

Definition at line 90 of file Messages.h.

◆ Negotiate1() [6/6]

Negotiate1	(	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

◆ blockLength()

constexpr BlockLength blockLength ( SchemaVersion version )

inlinestaticconstexprnoexcept

Size of message body in bytes.

Definition at line 360 of file Messages.h.

◆ calculateBinarySize()

EncodedLength calculateBinarySize ( ) const

inlinenoexcept

Returns: the size occupied by the message.

Definition at line 449 of file Messages.h.

◆ className()

constexpr const Char * className ( )

inlinestaticconstexpr

Returns: class name.

Definition at line 418 of file Messages.h.

◆ clientAppName()

StrRef clientAppName ( ) const

inlinenoexcept

Application name as informed during certification process.

Definition at line 281 of file Messages.h.

◆ clientAppVersion()

StrRef clientAppVersion ( ) const

inlinenoexcept

Application version as informed during certification process.

Definition at line 291 of file Messages.h.

◆ clientFlow()

constexpr FlowType::Enum clientFlow ( )

inlinestaticconstexprnoexcept

Type of flow from client to server.

It is a constant value = idempotent.

Definition at line 201 of file Messages.h.

◆ clientIP()

StrRef clientIP ( ) const

inlinenoexcept

Source IP from client system.

Definition at line 273 of file Messages.h.

◆ credentials()

StrRef credentials ( ) const

inlinenoexcept

Credentials to identify/authenticate the client. The format is a JSON with the following data: { "auth_type": "basic", "username": "session_id", "access_key": "somepassword" }.

Definition at line 263 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 212 of file Messages.h.

◆ fixType()

constexpr StrRef fixType ( )

inlinestaticconstexprnoexcept

FIX message type.

Definition at line 427 of file Messages.h.

◆ getMaxMessageSize()

constexpr UInt64 getMaxMessageSize ( UInt8 )

inlinestaticconstexprnoexcept

Maximal message size.

Definition at line 386 of file Messages.h.

◆ getMinimalVariableFieldsSize()

constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version )

inlinestaticconstexpr

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

Definition at line 374 of file Messages.h.

◆ messageType()

constexpr MessageType::Enum messageType ( )

inlinestaticconstexprnoexcept

Message type = Negotiate.

Definition at line 117 of file Messages.h.

◆ minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version )

inlinestaticconstexprnoexcept

Minimal size of message body in bytes.

Definition at line 348 of file Messages.h.

◆ onbehalfFirm()

bool onbehalfFirm ( FirmOptional & value ) const

inlinenoexcept

Identifies the broker firm who executes their orders on behalf.

Definition at line 233 of file Messages.h.

◆ reset()

ThisType & reset ( )

inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 405 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )

inlinenoexcept

Reset all variable-length fields if any.

Definition at line 394 of file Messages.h.

◆ sessionId()

SessionID sessionId ( ) const

inlinenoexcept

Message type = Negotiate.

Client connection identification on the gateway assigned by B3.

Definition at line 128 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 153 of file Messages.h.

◆ setClientAppName()

ThisType & setClientAppName ( StrRef value )

inline

Application name as informed during certification process.

Definition at line 322 of file Messages.h.

◆ setClientAppVersion()

ThisType & setClientAppVersion ( StrRef value )

inline

Application version as informed during certification process.

Definition at line 333 of file Messages.h.

◆ setClientIP()

ThisType & setClientIP ( StrRef value )

inline

Source IP from client system.

Definition at line 311 of file Messages.h.

◆ setCredentials()

ThisType & setCredentials ( StrRef value )

inline

Credentials to identify/authenticate the client. The format is a JSON with the following data: { "auth_type": "basic", "username": "session_id", "access_key": "somepassword" }.

Definition at line 300 of file Messages.h.

◆ setEnteringFirm()

ThisType & setEnteringFirm ( Firm value )

inlinenoexcept

Identifies the broker firm that will enter orders.

Definition at line 221 of file Messages.h.

◆ setOnbehalfFirm()

ThisType & setOnbehalfFirm ( FirmOptional value )

inlinenoexcept

Identifies the broker firm who executes their orders on behalf.

Definition at line 243 of file Messages.h.

◆ setOnbehalfFirmToNull()

ThisType & setOnbehalfFirmToNull ( )

inlinenoexcept

Definition at line 252 of file Messages.h.

◆ setSessionId()

ThisType & setSessionId ( SessionID value )

inlinenoexcept

Client connection identification on the gateway assigned by B3.

Definition at line 138 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 166 of file Messages.h.

◆ setTimestamp()

ThisType & setTimestamp ( UTCTimestampNanos value )

inlinenoexcept

Time of request.

Sent in number of nanoseconds since Unix epoch.

Definition at line 188 of file Messages.h.

◆ tail()

const void * tail ( ) const

inlinenoexcept

Returns: the end of the message.

Definition at line 439 of file Messages.h.

◆ timestamp()

UTCTimestampNanos timestamp ( ) const

inlinenoexcept

Time of request.

Sent in number of nanoseconds since Unix epoch.

Definition at line 178 of file Messages.h.

◆ toString()

std::string toString ( ) const

inline

Returns: a human-readable presentation.

Definition at line 64 of file MessageSerialization.h.

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Schema

◆ ThisType

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ Negotiate1() [1/6]

◆ Negotiate1() [2/6]

◆ Negotiate1() [3/6]

◆ Negotiate1() [4/6]

◆ Negotiate1() [5/6]

◆ Negotiate1() [6/6]

Member Function Documentation

◆ blockLength()

◆ calculateBinarySize()

◆ className()

◆ clientAppName()

◆ clientAppVersion()

◆ clientFlow()

◆ clientIP()

◆ credentials()

◆ enteringFirm()

◆ fixType()

◆ getMaxMessageSize()

◆ getMinimalVariableFieldsSize()

◆ messageType()

◆ minimalBlockLength()

◆ onbehalfFirm()

◆ reset()

◆ resetVariableFields()

◆ sessionId()

◆ sessionVerId()

◆ setClientAppName()

◆ setClientAppVersion()

◆ setClientIP()

◆ setCredentials()

◆ setEnteringFirm()

◆ setOnbehalfFirm()

◆ setOnbehalfFirmToNull()

◆ setSessionId()

◆ setSessionVerId()

◆ setTimestamp()

◆ tail()

◆ timestamp()

◆ toString()