OnixS C++ ICE Binary Order Entry Handler 1.1.1
API Documentation
Loading...
Searching...
No Matches
TraderLogoutRequest Struct Reference

Public Types

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

Public Member Functions

 TraderLogoutRequest ()=default
 TraderLogoutRequest (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
 TraderLogoutRequest (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
 TraderLogoutRequest (void *data, EncodedLength length, NoInit)
 TraderLogoutRequest (SbeMessage message)
 TraderLogoutRequest (void *data, EncodedLength length, NoInit, NoCheck) noexcept
auto originatorUserId () const noexcept
ThisTypeoriginatorUserId (StrRef value) noexcept
ThisTyperesetVariableFields () noexcept
ThisTypereset () 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
SbeMessagesequenceId (SequenceId value) noexcept
Timestamp sendTime () const noexcept
SbeMessagesendTime (Timestamp value) noexcept
HeaderFlags headerFlags () const noexcept
SbeMessageheaderFlags (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::SbeMessagecontainer () 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< MessageSizeGroupList
typedef SbeVariableLengthFieldList< MessageSizeVariableLengthFieldList
Protected Member Functions inherited from SbeMessage
SbeMessageversion (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 9690 of file Messages.h.

Member Typedef Documentation

◆ Schema

Used template schema.

Definition at line 9695 of file Messages.h.

◆ ThisType

This type alias.

Definition at line 9698 of file Messages.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 

Definition at line 9701 of file Messages.h.

9701{ TemplateId = 3 };

Constructor & Destructor Documentation

◆ TraderLogoutRequest() [1/6]

TraderLogoutRequest ( )
default

Initializes a blank instance.

◆ TraderLogoutRequest() [2/6]

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

Initializes an instance over the given memory block.

Definition at line 9707 of file Messages.h.

9708 : SbeMessage(data, length, version)
9709 {
9710 checkVersion<Schema>(version);
9711 checkLength(length, version);
9712 init(TemplateId, minimalBlockLength(version), blockLength(version), Schema::Id);
9713 reset();
9714 }

◆ TraderLogoutRequest() [3/6]

TraderLogoutRequest ( 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 9719 of file Messages.h.

9720 : SbeMessage(data, length, version)
9721 {
9722 checkVersion<Schema>(version);
9723 checkLength(length, version);
9724 init(TemplateId, minimalBlockLength(version), blockLength(version), Schema::Id);
9725 resetVariableFields();
9726 }

◆ TraderLogoutRequest() [4/6]

TraderLogoutRequest ( void * data,
EncodedLength length,
NoInit  )
inline

Creates an instance over the given memory block.

Definition at line 9729 of file Messages.h.

9730 : SbeMessage(data, length)
9731 {
9732 checkCompatibility();
9733 }

◆ TraderLogoutRequest() [5/6]

TraderLogoutRequest ( SbeMessage message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 9737 of file Messages.h.

9738 : SbeMessage(message)
9739 {
9740 assert(message.valid());
9741
9742 checkCompatibility();
9743 }

◆ TraderLogoutRequest() [6/6]

TraderLogoutRequest ( void * data,
EncodedLength length,
NoInit ,
NoCheck  )
inlinenoexcept

Creates an instance over the given memory block.

Performs no checks.

Definition at line 9747 of file Messages.h.

9748 : SbeMessage(data, length, NoCheck())
9749 {
9750 assert(schemaId() == Schema::Id);
9751 assert(version() >= Schema::MinimalVersion);
9752 assert(TemplateId == templateId());
9753 }
const char * version() noexcept

Member Function Documentation

◆ blockLength()

constexpr BlockLength blockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Size of message body in bytes.

Definition at line 9786 of file Messages.h.

9787 {
9788 return
9789 ONIXS_ICEBOE_ASSERT(version >= Schema::MinimalVersion),
9790 minimalBlockLength(version);
9791 }

◆ calculateBinarySize()

EncodedLength calculateBinarySize ( ) const
inlinenoexcept
Returns
the size occupied by the message.

Definition at line 9860 of file Messages.h.

9861 {
9862 return
9863 SbeMessage::calculateBinarySize(tail());
9864 }

◆ className()

constexpr StrRef className ( )
inlinestaticconstexprnoexcept
Returns
class name.

Definition at line 9829 of file Messages.h.

9830 {
9831 return constructStrRef("TraderLogoutRequest");
9832 }
constexpr StrRef constructStrRef(const char(&value)[Size]) noexcept
Definition StrRef.h:414

◆ fixType()

constexpr StrRef fixType ( )
inlinestaticconstexprnoexcept

FIX message type.

Definition at line 9837 of file Messages.h.

9838 {
9839 return constructStrRef("TraderLogoutRequest");
9840 }

◆ getMaxMessageSize()

constexpr UInt64 getMaxMessageSize ( UInt8 )
inlinestaticconstexprnoexcept

Maximal message size.

Definition at line 9806 of file Messages.h.

9807 {
9808 return
9809 static_cast<UInt64>(MessageHeaderBuilder::Size) +
9810 blockLength(Schema::Version);
9811 }

◆ getMinimalVariableFieldsSize()

constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version)
inlinestaticconstexpr

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

Definition at line 9796 of file Messages.h.

9797 {
9798 return
9799 ONIXS_ICEBOE_ASSERT(version >= Schema::MinimalVersion),
9800 0;
9801 }

◆ minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Minimal size of message body in bytes.

Definition at line 9777 of file Messages.h.

9778 {
9779 return
9780 ONIXS_ICEBOE_ASSERT(version >= Schema::MinimalVersion),
9781 20;
9782 }

◆ originatorUserId() [1/2]

auto originatorUserId ( ) const
inlinenoexcept

Trader ID.

Definition at line 9757 of file Messages.h.

9758 {
9759 constexpr BlockLength offset = 0;
9760 constexpr BlockLength length = 20;
9761
9762 return fixedStr<length>(offset);
9763 }

◆ originatorUserId() [2/2]

ThisType & originatorUserId ( StrRef value)
inlinenoexcept

Trader ID.

Definition at line 9766 of file Messages.h.

9767 {
9768 constexpr BlockLength offset = 0;
9769 constexpr BlockLength length = 20;
9770
9771 setFixedStr<length>(offset, value);
9772 return *this;
9773 }

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 9820 of file Messages.h.

9821 {
9822 resetVariableFields();
9823 return *this;
9824 }

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 9814 of file Messages.h.

9815 {
9816 return *this;
9817 }

◆ tail()

const void * tail ( ) const
inlinenoexcept
Returns
the end of the message.

Definition at line 9848 of file Messages.h.

9849 {
9850 return
9853 binary(),
9854 static_cast<ptrdiff_t>(SbeMessage::blockLength()) +
9855 MessageHeader::Size));
9856 }
ONIXS_ICEBOE_FORCEINLINE void * toOpaquePtr(Type *ptr) noexcept
Makes the pointer an opaque one.
Definition Memory.h:51
ONIXS_ICEBOE_FORCEINLINE Type * advanceByBytes(Type *pointer, ptrdiff_t distance) noexcept
Advances the pointer to a given offset (distance) in bytes.
Definition Memory.h:110

◆ toString()

std::string toString ( ) const
inline
Returns
a human-readable presentation.

Definition at line 889 of file MessageSerialization.h.

890{
891 return toStr(*this);
892}
std::string toStr(Order::PriceOptional value)
Definition Order.cpp:34