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

Public Member Functions
	Establish4 ()=default
	Establish4 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
	Establish4 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
	Establish4 (void *data, EncodedLength length, NoInit)
	Establish4 (const SbeMessage &message)
	Establish4 (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
DeltaInMillis	keepAliveInterval () const noexcept
ThisType &	setKeepAliveInterval (DeltaInMillis value) noexcept
SeqNum	nextSeqNo () const noexcept
ThisType &	setNextSeqNo (SeqNum value) noexcept
CancelOnDisconnectType::Enum	cancelOnDisconnectType () const noexcept
ThisType &	setCancelOnDisconnectType (CancelOnDisconnectType::Enum value) noexcept
DeltaInMillis	codTimeoutWindow () const noexcept
ThisType &	setCodTimeoutWindow (DeltaInMillis value) noexcept
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 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 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 1370 of file Messages.h.

Member Typedef Documentation

◆ Schema

typedef SchemaTraits Schema

Used template schema.

Definition at line 1375 of file Messages.h.

◆ ThisType

typedef Establish4 ThisType

This type alias.

Definition at line 1378 of file Messages.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId	4

Definition at line 1381 of file Messages.h.

Constructor & Destructor Documentation

◆ Establish4() [1/6]

Establish4 ( )

default

Initializes a blank instance.

◆ Establish4() [2/6]

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

inline

Initializes an instance over the given memory block.

Definition at line 1387 of file Messages.h.

◆ Establish4() [3/6]

Establish4	(	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 1402 of file Messages.h.

◆ Establish4() [4/6]

Establish4	(	void *	data,
		EncodedLength	length,
		NoInit	)

inline

Creates an instance over the given memory block.

Definition at line 1416 of file Messages.h.

◆ Establish4() [5/6]

Establish4 ( const SbeMessage & message )

inlineexplicit

Creates an instance over the given SBE message.

Definition at line 1427 of file Messages.h.

◆ Establish4() [6/6]

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

inlinenoexcept

Creates an instance over the given memory block.

Performs no checks.

Definition at line 1438 of file Messages.h.

Member Function Documentation

◆ blockLength()

constexpr BlockLength blockLength ( SchemaVersion version )

inlinestaticconstexprnoexcept

Size of message body in bytes.

Definition at line 1671 of file Messages.h.

◆ calculateBinarySize()

EncodedLength calculateBinarySize ( ) const

inlinenoexcept

Returns: the size occupied by the message.

Definition at line 1756 of file Messages.h.

◆ cancelOnDisconnectType()

CancelOnDisconnectType::Enum cancelOnDisconnectType ( ) const

inlinenoexcept

Criteria used to initiate cancel on disconnect mechanism by the gateway.

Definition at line 1584 of file Messages.h.

◆ className()

constexpr const Char * className ( )

inlinestaticconstexpr

Returns: class name.

Definition at line 1725 of file Messages.h.

◆ codTimeoutWindow()

DeltaInMillis codTimeoutWindow ( ) const

inlinenoexcept

Gateway will not trigger CoD if the customer reconnects within the timeout window (milliseconds) which starts when the triggering event is detected.

Range is 0 (as soon as possible) to 60000.

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

◆ fixType()

constexpr StrRef fixType ( )

inlinestaticconstexprnoexcept

FIX message type.

Definition at line 1734 of file Messages.h.

◆ getMaxMessageSize()

constexpr UInt64 getMaxMessageSize ( UInt8 )

inlinestaticconstexprnoexcept

Maximal message size.

Definition at line 1698 of file Messages.h.

◆ getMinimalVariableFieldsSize()

constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version )

inlinestaticconstexpr

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

Definition at line 1686 of file Messages.h.

◆ keepAliveInterval()

DeltaInMillis keepAliveInterval ( ) const

inlinenoexcept

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

It should be in the range of 1000 to 60000 (inclusive).

Definition at line 1538 of file Messages.h.

◆ messageType()

constexpr MessageType::Enum messageType ( )

inlinestaticconstexprnoexcept

Message type = Establish.

Definition at line 1454 of file Messages.h.

◆ minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version )

inlinestaticconstexprnoexcept

Minimal size of message body in bytes.

Definition at line 1657 of file Messages.h.

◆ nextSeqNo()

SeqNum nextSeqNo ( ) const

inlinenoexcept

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

Definition at line 1561 of file Messages.h.

◆ reset()

ThisType & reset ( )

inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 1714 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )

inlinenoexcept

Reset all variable-length fields if any.

Definition at line 1706 of file Messages.h.

◆ sessionId()

SessionID sessionId ( ) const

inlinenoexcept

Message type = Establish.

Client connection identification on the gateway assigned by B3.

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

◆ setCancelOnDisconnectType()

ThisType & setCancelOnDisconnectType ( CancelOnDisconnectType::Enum value )

inlinenoexcept

Criteria used to initiate cancel on disconnect mechanism by the gateway.

Definition at line 1595 of file Messages.h.

◆ setCodTimeoutWindow()

ThisType & setCodTimeoutWindow ( DeltaInMillis value )

inlinenoexcept

Gateway will not trigger CoD if the customer reconnects within the timeout window (milliseconds) which starts when the triggering event is detected.

Range is 0 (as soon as possible) to 60000.

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

◆ setKeepAliveInterval()

ThisType & setKeepAliveInterval ( DeltaInMillis value )

inlinenoexcept

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

It should be in the range of 1000 to 60000 (inclusive).

Definition at line 1549 of file Messages.h.

◆ setNextSeqNo()

ThisType & setNextSeqNo ( SeqNum value )

inlinenoexcept

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

Definition at line 1571 of file Messages.h.

◆ setSessionId()

ThisType & setSessionId ( SessionID value )

inlinenoexcept

Client connection identification on the gateway assigned by B3.

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

◆ setTimestamp()

ThisType & setTimestamp ( UTCTimestampNanos value )

inlinenoexcept

Time of request.

Sent in number of nanoseconds since Unix epoch.

Definition at line 1525 of file Messages.h.

◆ tail()

const void * tail ( ) const

inlinenoexcept

Returns: the end of the message.

Definition at line 1746 of file Messages.h.

◆ timestamp()

UTCTimestampNanos timestamp ( ) const

inlinenoexcept

Time of request.

Sent in number of nanoseconds since Unix epoch.

Definition at line 1515 of file Messages.h.

◆ toString()

std::string toString ( ) const

inline

Returns: a human-readable presentation.

Definition at line 202 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

◆ Establish4() [1/6]

◆ Establish4() [2/6]

◆ Establish4() [3/6]

◆ Establish4() [4/6]

◆ Establish4() [5/6]

◆ Establish4() [6/6]

Member Function Documentation

◆ blockLength()

◆ calculateBinarySize()

◆ cancelOnDisconnectType()

◆ className()

◆ codTimeoutWindow()

◆ credentials()

◆ fixType()

◆ getMaxMessageSize()

◆ getMinimalVariableFieldsSize()

◆ keepAliveInterval()

◆ messageType()

◆ minimalBlockLength()

◆ nextSeqNo()

◆ reset()

◆ resetVariableFields()

◆ sessionId()

◆ sessionVerId()

◆ setCancelOnDisconnectType()

◆ setCodTimeoutWindow()

◆ setCredentials()

◆ setKeepAliveInterval()

◆ setNextSeqNo()

◆ setSessionId()

◆ setSessionVerId()

◆ setTimestamp()

◆ tail()

◆ timestamp()

◆ toString()