#include <OnixS/B3/BOE/messaging/Messages.h>

Public Types
enum	{ TemplateId = 4 }

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 (MessageSizeoffset) noexcept

void	setOrdinary (MessageSizeoffset, FieldValue value) noexcept

void	setOrdinary (MessageSizeoffset, FieldValue value, SchemaVersion since)

void	setEnumeration (MessageSizeoffset, typename Enumeration::Enum value) noexcept

void	setEnumeration (MessageSizeoffset, typename Enumeration::Enum value, SchemaVersion since)

void	setFixedStr (MessageSizeoffset, StrRef value) noexcept

void	setFixedStr (MessageSizeoffset, StrRef value, SchemaVersion since)

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 (MessageSizeoffset) const noexcept

bool	ordinary (Value &value, MessageSizeoffset, NullValue null) const noexcept

bool	ordinary (Value &value, MessageSizeoffset, NullValue null, SchemaVersion since) const noexcept

const Value &	accessOrdinary (MessageSizeoffset) const noexcept

Value &	accessOrdinary (MessageSizeoffset) noexcept

Enumeration::Enum	enumeration (MessageSizeoffset) const noexcept

bool	enumeration (typename Enumeration::Enum &value, MessageSizeoffset, NullValue null) const noexcept

bool	enumeration (typename Enumeration::Enum &value, MessageSizeoffset, NullValue null, SchemaVersion since) const noexcept

Value	decimal (MessageSizeoffset) const noexcept

bool	decimal (Value &value, MessageSizeoffset, NullValue null) const noexcept

bool	decimal (Value &value, MessageSizeoffset, NullValue null, SchemaVersion since) const noexcept

StrRef	fixedStr (MessageSizeoffset) const noexcept

bool	fixedStr (StrRef &value, MessageSizeoffset) const noexcept

bool	fixedStr (StrRef &value, MessageSizeoffset, SchemaVersion since) const noexcept

Static Protected Member Functions inherited from SbeMessage
static constexpr MessageSize	getMaxMessageSize () noexcept

Detailed Description

Definition at line 1334 of file Messages.h.

Member Typedef Documentation

typedef SchemaTraits Schema

Used template schema.

Definition at line 1339 of file Messages.h.

typedef Establish4 ThisType

This type alias.

Definition at line 1342 of file Messages.h.

Member Enumeration Documentation

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId

Definition at line 1345 of file Messages.h.

Constructor & Destructor Documentation

Establish4 ( )

default

Initializes a blank instance.

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

inline

Initializes an instance over the given memory block.

Definition at line 1351 of file Messages.h.

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

Establish4	(	void *	data,
		EncodedLength	length,
		NoInit
	)

inline

Creates an instance over the given memory block.

Definition at line 1380 of file Messages.h.

Establish4 ( const SbeMessage & message )

inlineexplicit

Creates an instance over the given SBE message.

Definition at line 1391 of file Messages.h.

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

inlinenoexcept

Creates an instance over the given memory block.

Performs no checks.

Definition at line 1402 of file Messages.h.

Member Function Documentation

static constexpr BlockLength blockLength ( SchemaVersion version )

inlinestaticnoexcept

Size of message body in bytes.

Definition at line 1635 of file Messages.h.

EncodedLength calculateBinarySize ( ) const

inlinenoexcept

Returns: the size occupied by the message.

Definition at line 1720 of file Messages.h.

CancelOnDisconnectType::Enum cancelOnDisconnectType ( ) const

inlinenoexcept

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

Definition at line 1548 of file Messages.h.

static constexpr const Char* className ( )

inlinestatic

Returns: class name.

Definition at line 1689 of file Messages.h.

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

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

static constexpr StrRef fixType ( )

inlinestaticnoexcept

FIX message type.

Definition at line 1698 of file Messages.h.

static constexpr UInt64 getMaxMessageSize ( UInt8 )

inlinestaticnoexcept

Maximal message size.

Definition at line 1662 of file Messages.h.

static constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version )

inlinestatic

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

Definition at line 1650 of file Messages.h.

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

static constexpr MessageType::Enum messageType ( )

inlinestaticnoexcept

Message type = Establish.

Definition at line 1418 of file Messages.h.

static constexpr BlockLength minimalBlockLength ( SchemaVersion version )

inlinestaticnoexcept

Minimal size of message body in bytes.

Definition at line 1621 of file Messages.h.

SeqNum nextSeqNo ( ) const

inlinenoexcept

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

Definition at line 1525 of file Messages.h.

ThisType& reset ( )

inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 1678 of file Messages.h.

ThisType& resetVariableFields ( )

inlinenoexcept

Reset all variable-length fields if any.

Definition at line 1670 of file Messages.h.

SessionID sessionId ( ) const

inlinenoexcept

Message type = Establish.

Client connection identification on the gateway assigned by B3.

Definition at line 1429 of file Messages.h.

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

ThisType& setCancelOnDisconnectType ( CancelOnDisconnectType::Enum value )

inlinenoexcept

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

Definition at line 1559 of file Messages.h.

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

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

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

ThisType& setNextSeqNo ( SeqNum value )

inlinenoexcept

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

Definition at line 1535 of file Messages.h.

ThisType& setSessionId ( SessionID value )

inlinenoexcept

Client connection identification on the gateway assigned by B3.

Definition at line 1439 of file Messages.h.

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

ThisType& setTimestamp ( UTCTimestampNanos value )

inlinenoexcept

Time of request.

Sent in number of nanoseconds since Unix epoch.

Definition at line 1489 of file Messages.h.

const void* tail ( ) const

inlinenoexcept

Returns: the end of the message.

Definition at line 1710 of file Messages.h.

UTCTimestampNanos timestamp ( ) const

inlinenoexcept

Time of request.

Sent in number of nanoseconds since Unix epoch.

Definition at line 1479 of file Messages.h.

std::string toString ( ) const

inline

Returns: a human-readable presentation.

Definition at line 202 of file MessageSerialization.h.

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

OnixS/B3/BOE/messaging/Messages.h
OnixS/B3/BOE/messaging/MessageSerialization.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation