LogonRequest Struct Reference

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

Public Member Functions
	LogonRequest ()=default
	LogonRequest (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
	LogonRequest (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
	LogonRequest (void *data, EncodedLength length, NoInit)
	LogonRequest (SbeMessage message)
	LogonRequest (void *data, EncodedLength length, NoInit, NoCheck) noexcept
auto	userId () const noexcept
ThisType &	userId (StrRef value) noexcept
auto	clientId () const noexcept
ThisType &	clientId (Int32 value) noexcept
auto	heartBeatInterval () const noexcept
ThisType &	heartBeatInterval (Uint16NULL value) noexcept
ThisType &	heartBeatInterval (NullOpt) noexcept
auto	applicationName () const noexcept
ThisType &	applicationName (StrRef value) noexcept
auto	applicationVersion () const noexcept
ThisType &	applicationVersion (StrRef value) noexcept
auto	applicationVendor () const noexcept
ThisType &	applicationVendor (StrRef value) noexcept
auto	rawData () const noexcept
ThisType &	rawData (StrRef value) noexcept
auto	ipSessionToken () const noexcept
ThisType &	ipSessionToken (StrRef value) noexcept
ThisType &	ipSessionToken (NullOpt) noexcept
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
	operator bool () const noexcept
MessageTemplateId	templateId () const noexcept
SchemaVersion	version () const noexcept
SchemaId	schemaId () const noexcept
SequenceId	sequenceId () const noexcept
SbeMessage &	sequenceId (SequenceId value) noexcept
Timestamp	sendTime () const noexcept
SbeMessage &	sendTime (Timestamp value) noexcept
HeaderFlags	headerFlags () const noexcept
SbeMessage &	headerFlags (HeaderFlags value) 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 >
ONIXS_ICEBOE_FORCEINLINE Messaging::SbeMessage &	container () noexcept
void	zeroPaddingBytes (MessageSize offset) noexcept
ONIXS_ICEBOE_FORCEINLINE void	setOrdinary (MessageSize offset, FieldValue value) noexcept
ONIXS_ICEBOE_FORCEINLINE void	setEnumeration (MessageSize offset, Enumeration value) noexcept
ONIXS_ICEBOE_FORCEINLINE void	setFixedStr (MessageSize offset, StrRef value) noexcept

Static Public Member Functions
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)
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>
ONIXS_ICEBOE_FORCEINLINE Group	getGroup (Callable callable, Owner &owner) const noexcept
template<class Group, class Callable, class Owner>
ONIXS_ICEBOE_FORCEINLINE Group	getGroup (Callable callable, SchemaVersion since, Owner &owner) const noexcept
template<class Group, class Callable, class Owner>
ONIXS_ICEBOE_FORCEINLINE Group	constructGroup (Callable callable, typename Group::Size length, SchemaVersion since, Owner &owner)
template<class Group, class Callable, class Owner>
ONIXS_ICEBOE_FORCEINLINE 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
ONIXS_ICEBOE_FORCEINLINE Value	ordinary (MessageSize offset) const noexcept
ONIXS_ICEBOE_FORCEINLINE Enumeration	enumeration (MessageSize offset) const noexcept
ONIXS_ICEBOE_FORCEINLINE StrRef	fixedStr (MessageSize offset) const noexcept
ONIXS_ICEBOE_FORCEINLINE Value	decimal (MessageSize offset) const noexcept
ONIXS_ICEBOE_FORCEINLINE std::enable_if<!isComposite< typenameNullValue::Value >::value, SbeOptionalConverted< decltype(std::declval< Callable >()(std::declval< typenameArgType< Callable >::type >()))> >::type	convertible (MessageSize offset, OptionalTag) const noexcept(noexcept(Callable::Nothrow))
Protected Member Functions inherited from BinaryBlockBase
	~BinaryBlockBase ()=default
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 LogonRequest 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.

{ TemplateId = 1 };

Constructor & Destructor Documentation

LogonRequest() [1/6]

LogonRequest ( )

default

Initializes a blank instance.

LogonRequest() [2/6]

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

      : SbeMessage(data, length, version)
    {
        checkVersion<Schema>(version);
        checkLength(length, version);
        init(TemplateId, minimalBlockLength(version), blockLength(version), Schema::Id);
        reset();
    }

LogonRequest() [3/6]

LogonRequest ( 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 62 of file Messages.h.

      : SbeMessage(data, length, version)
    {
        checkVersion<Schema>(version);
        checkLength(length, version);
        init(TemplateId, minimalBlockLength(version), blockLength(version), Schema::Id);
        resetVariableFields();
    }

LogonRequest() [4/6]

LogonRequest ( void * data, EncodedLength length, NoInit  )

inline

Creates an instance over the given memory block.

Definition at line 72 of file Messages.h.

      : SbeMessage(data, length)
    {
        checkCompatibility();
    }

LogonRequest() [5/6]

LogonRequest ( SbeMessage message )

inlineexplicit

Creates an instance over the given SBE message.

Definition at line 80 of file Messages.h.

      : SbeMessage(message)
    {
        assert(message.valid());
 
        checkCompatibility();
    }

LogonRequest() [6/6]

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

inlinenoexcept

Creates an instance over the given memory block.

Performs no checks.

Definition at line 90 of file Messages.h.

      : SbeMessage(data, length, NoCheck())
    {
        assert(schemaId() == Schema::Id);
        assert(version() >= Schema::MinimalVersion);
        assert(TemplateId == templateId());
    }

Member Function Documentation

applicationName() [1/2]

auto applicationName ( ) const

inlinenoexcept

Name of client application.

Definition at line 164 of file Messages.h.

    {
        constexpr BlockLength offset = 26;
        constexpr BlockLength length = 30;
 
        return fixedStr<length>(offset);
    }

applicationName() [2/2]

ThisType & applicationName ( StrRef value )

inlinenoexcept

Name of client application.

Definition at line 173 of file Messages.h.

    {
        constexpr BlockLength offset = 26;
        constexpr BlockLength length = 30;
 
        setFixedStr<length>(offset, value);
        return *this;
    }

applicationVendor() [1/2]

auto applicationVendor ( ) const

inlinenoexcept

Vendor of client application.

Definition at line 204 of file Messages.h.

    {
        constexpr BlockLength offset = 106;
        constexpr BlockLength length = 30;
 
        return fixedStr<length>(offset);
    }

applicationVendor() [2/2]

ThisType & applicationVendor ( StrRef value )

inlinenoexcept

Vendor of client application.

Definition at line 213 of file Messages.h.

    {
        constexpr BlockLength offset = 106;
        constexpr BlockLength length = 30;
 
        setFixedStr<length>(offset, value);
        return *this;
    }

applicationVersion() [1/2]

auto applicationVersion ( ) const

inlinenoexcept

Version of client application.

Definition at line 184 of file Messages.h.

    {
        constexpr BlockLength offset = 56;
        constexpr BlockLength length = 50;
 
        return fixedStr<length>(offset);
    }

applicationVersion() [2/2]

ThisType & applicationVersion ( StrRef value )

inlinenoexcept

Version of client application.

Definition at line 193 of file Messages.h.

    {
        constexpr BlockLength offset = 56;
        constexpr BlockLength length = 50;
 
        setFixedStr<length>(offset, value);
        return *this;
    }

blockLength()

constexpr BlockLength blockLength ( SchemaVersion version )

inlinestaticconstexprnoexcept

Size of message body in bytes.

Definition at line 284 of file Messages.h.

    {
        return
            ONIXS_ICEBOE_ASSERT(version >= Schema::MinimalVersion),
            minimalBlockLength(version);
    }

calculateBinarySize()

EncodedLength calculateBinarySize ( ) const

inlinenoexcept

Returns

the size occupied by the message.

Definition at line 361 of file Messages.h.

    {
        return
            SbeMessage::calculateBinarySize(tail());
    }

className()

constexpr StrRef className ( )

inlinestaticconstexprnoexcept

Returns

class name.

Definition at line 330 of file Messages.h.

    {
        return constructStrRef("LogonRequest");
    }

clientId() [1/2]

auto clientId ( ) const

inlinenoexcept

Company ID of Gateway ID.

Definition at line 120 of file Messages.h.

    {
        constexpr BlockLength offset = 20;
 
        return ordinary<Int32>(offset);
    }

clientId() [2/2]

ThisType & clientId ( Int32 value )

inlinenoexcept

Company ID of Gateway ID.

Definition at line 128 of file Messages.h.

    {
        constexpr BlockLength offset = 20;
 
        setOrdinary(offset, value);
        return *this;
    }

fixType()

constexpr StrRef fixType ( )

inlinestaticconstexprnoexcept

FIX message type.

Definition at line 338 of file Messages.h.

    {
        return constructStrRef("A");
    }

getMaxMessageSize()

constexpr UInt64 getMaxMessageSize ( UInt8 )

inlinestaticconstexprnoexcept

Maximal message size.

Definition at line 304 of file Messages.h.

    {
        return
            static_cast<UInt64>(MessageHeaderBuilder::Size) +
            blockLength(Schema::Version);
    }

getMinimalVariableFieldsSize()

constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version )

inlinestaticconstexpr

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

Definition at line 294 of file Messages.h.

    {
        return
            ONIXS_ICEBOE_ASSERT(version >= Schema::MinimalVersion),
            0;
    }

heartBeatInterval() [1/3]

auto heartBeatInterval ( ) const

inlinenoexcept

Default of 30 seconds.

Definition at line 138 of file Messages.h.

    {
        constexpr BlockLength offset = 24;
 
        return ordinary<NullUint16NULL>(offset, optional);
    }

heartBeatInterval() [2/3]

ThisType & heartBeatInterval ( NullOpt )

inlinenoexcept

Definition at line 154 of file Messages.h.

    {
        constexpr BlockLength offset = 24;
 
        setOrdinary(offset, NullUint16NULL());
        return *this;
    }

heartBeatInterval() [3/3]

ThisType & heartBeatInterval ( Uint16NULL value )

inlinenoexcept

Default of 30 seconds.

Definition at line 146 of file Messages.h.

    {
        constexpr BlockLength offset = 24;
 
        setOrdinary(offset, value);
        return *this;
    }

ipSessionToken() [1/3]

auto ipSessionToken ( ) const

inlinenoexcept

ipSessionToken from Binary Utility Service Gateway (BUS).

Required for Binary Order Gateway (BGW) logons requests.

Definition at line 245 of file Messages.h.

    {
        constexpr BlockLength offset = 186;
        constexpr BlockLength length = 50;
 
        return fixedStr<length>(offset, optional);
    }

ipSessionToken() [2/3]

ThisType & ipSessionToken ( NullOpt )

inlinenoexcept

Definition at line 264 of file Messages.h.

    {
        constexpr BlockLength offset = 186;
        constexpr BlockLength length = 50;
 
        setFixedStr<length>(offset, StrRef());
        return *this;
    }

ipSessionToken() [3/3]

ThisType & ipSessionToken ( StrRef value )

inlinenoexcept

ipSessionToken from Binary Utility Service Gateway (BUS).

Required for Binary Order Gateway (BGW) logons requests.

Definition at line 255 of file Messages.h.

    {
        constexpr BlockLength offset = 186;
        constexpr BlockLength length = 50;
 
        setFixedStr<length>(offset, value);
        return *this;
    }

minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version )

inlinestaticconstexprnoexcept

Minimal size of message body in bytes.

Definition at line 275 of file Messages.h.

    {
        return
            ONIXS_ICEBOE_ASSERT(version >= Schema::MinimalVersion),
            236;
    }

rawData() [1/2]

auto rawData ( ) const

inlinenoexcept

Password of Gateway ID.

Definition at line 224 of file Messages.h.

    {
        constexpr BlockLength offset = 136;
        constexpr BlockLength length = 50;
 
        return fixedStr<length>(offset);
    }

rawData() [2/2]

ThisType & rawData ( StrRef value )

inlinenoexcept

Password of Gateway ID.

Definition at line 233 of file Messages.h.

    {
        constexpr BlockLength offset = 136;
        constexpr BlockLength length = 50;
 
        setFixedStr<length>(offset, value);
        return *this;
    }

reset()

ThisType & reset ( )

inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 318 of file Messages.h.

    {
        heartBeatInterval(nullOpt);
        ipSessionToken(nullOpt);
 
        resetVariableFields();
        return *this;
    }

resetVariableFields()

ThisType & resetVariableFields ( )

inlinenoexcept

Reset all variable-length fields if any.

Definition at line 312 of file Messages.h.

    {
        return *this;
    }

tail()

const void * tail ( ) const

inlinenoexcept

Returns

the end of the message.

Definition at line 349 of file Messages.h.

    {
        return
            toOpaquePtr(
                advanceByBytes(
                    binary(),
                    static_cast<ptrdiff_t>(SbeMessage::blockLength()) +
                        MessageHeader::Size));
    }

toString()

std::string toString ( ) const

inline

Returns

a human-readable presentation.

Definition at line 60 of file MessageSerialization.h.

{
    return toStr(*this);
}

userId() [1/2]

auto userId ( ) const

inlinenoexcept

Gateway ID.

Definition at line 100 of file Messages.h.

    {
        constexpr BlockLength offset = 0;
        constexpr BlockLength length = 20;
 
        return fixedStr<length>(offset);
    }

userId() [2/2]

ThisType & userId ( StrRef value )

inlinenoexcept

Gateway ID.

Definition at line 109 of file Messages.h.

    {
        constexpr BlockLength offset = 0;
        constexpr BlockLength length = 20;
 
        setFixedStr<length>(offset, value);
        return *this;
    }