OnixS C++ B3 BOE Binary Order Entry 1.4.0
Users' manual and API documentation
Loading...
Searching...
No Matches
SecurityDefinitionResponse301 Struct Reference

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

Public Types

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

Public Member Functions

 SecurityDefinitionResponse301 ()=default
 SecurityDefinitionResponse301 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
 SecurityDefinitionResponse301 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
 SecurityDefinitionResponse301 (void *data, EncodedLength length, NoInit)
 SecurityDefinitionResponse301 (const SbeMessage &message)
 SecurityDefinitionResponse301 (void *data, EncodedLength length, NoInit, NoCheck) noexcept
const OutboundBusinessHeaderbusinessHeader () const noexcept
OutboundBusinessHeaderbusinessHeader () noexcept
SecurityReqRespID securityReqId () const noexcept
ThisTypesetSecurityReqId (SecurityReqRespID value) noexcept
bool securityId (SecurityIDOptional &value) const noexcept
ThisTypesetSecurityId (SecurityIDOptional value) noexcept
ThisTypesetSecurityIdToNull () noexcept
SecurityResponseType::Enum securityResponseType () const noexcept
ThisTypesetSecurityResponseType (SecurityResponseType::Enum value) noexcept
bool securityStrategyType (StrRef &value) const noexcept
ThisTypesetSecurityStrategyType (StrRef value) noexcept
ThisTypesetSecurityStrategyTypeToNull () noexcept
StrRef symbol () const noexcept
ThisTypesetSymbol (StrRef value) noexcept
SecurityReqRespID securityResponseId () const noexcept
ThisTypesetSecurityResponseId (SecurityReqRespID value) noexcept
StrRef senderLocation () const noexcept
ThisTypesetSenderLocation (StrRef value) noexcept
StrRef enteringTrader () const noexcept
ThisTypesetEnteringTrader (StrRef value) noexcept
ThisTyperesetVariableFields () noexcept
ThisTypereset () noexcept
void toString (std::string &dest, bool skipEmptyFields=false)
std::string toString (bool skipEmptyFields=false) 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::SbeMessagecontainer () 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 SecurityIDSource::Enum securityIdSource () noexcept
static constexpr StrRef securityExchange () 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 CharclassName ()
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>
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 17889 of file Messages.h.

Member Typedef Documentation

◆ Schema

Used template schema.

Definition at line 17894 of file Messages.h.

◆ ThisType

This type alias.

Definition at line 17897 of file Messages.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 301 

Definition at line 17900 of file Messages.h.

Constructor & Destructor Documentation

◆ SecurityDefinitionResponse301() [1/6]

Initializes a blank instance.

◆ SecurityDefinitionResponse301() [2/6]

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

Initializes an instance over the given memory block.

Definition at line 17906 of file Messages.h.

◆ SecurityDefinitionResponse301() [3/6]

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

◆ SecurityDefinitionResponse301() [4/6]

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

Creates an instance over the given memory block.

Definition at line 17935 of file Messages.h.

◆ SecurityDefinitionResponse301() [5/6]

SecurityDefinitionResponse301 ( const SbeMessage & message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 17946 of file Messages.h.

◆ SecurityDefinitionResponse301() [6/6]

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

Creates an instance over the given memory block. Performs no checks.

Definition at line 17957 of file Messages.h.

Member Function Documentation

◆ blockLength()

constexpr BlockLength blockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Size of message body in bytes.

Definition at line 18238 of file Messages.h.

◆ businessHeader() [1/2]

const OutboundBusinessHeader & businessHeader ( ) const
inlinenoexcept

Message type = SecurityDefinitionResponse.

Common header to all outbound business messages.

Definition at line 17984 of file Messages.h.

◆ businessHeader() [2/2]

OutboundBusinessHeader & businessHeader ( )
inlinenoexcept

Common header to all outbound business messages.

Definition at line 17993 of file Messages.h.

◆ calculateBinarySize()

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

Definition at line 18338 of file Messages.h.

◆ className()

constexpr const Char * className ( )
inlinestaticconstexpr
Returns
class name.

Definition at line 18297 of file Messages.h.

◆ enteringTrader()

StrRef enteringTrader ( ) const
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 18199 of file Messages.h.

◆ fixType()

constexpr StrRef fixType ( )
inlinestaticconstexprnoexcept

FIX message type.

Definition at line 18306 of file Messages.h.

◆ getMaxMessageSize()

constexpr UInt64 getMaxMessageSize ( UInt8 )
inlinestaticconstexprnoexcept

Maximal message size.

Definition at line 18265 of file Messages.h.

◆ getMinimalVariableFieldsSize()

constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion version)
inlinestaticconstexpr

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

Definition at line 18253 of file Messages.h.

◆ messageType()

constexpr MessageType::Enum messageType ( )
inlinestaticconstexprnoexcept

Message type = SecurityDefinitionResponse.

Definition at line 17973 of file Messages.h.

◆ minimalBlockLength()

constexpr BlockLength minimalBlockLength ( SchemaVersion version)
inlinestaticconstexprnoexcept

Minimal size of message body in bytes.

Definition at line 18224 of file Messages.h.

◆ reset()

ThisType & reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 18281 of file Messages.h.

◆ resetVariableFields()

ThisType & resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 18274 of file Messages.h.

◆ securityExchange()

constexpr StrRef securityExchange ( )
inlinestaticconstexprnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Market to which the symbol belongs.

Definition at line 18066 of file Messages.h.

◆ securityId()

bool securityId ( SecurityIDOptional & value) const
inlinenoexcept

Security identification as defined by exchange.

Definition at line 18023 of file Messages.h.

◆ securityIdSource()

constexpr SecurityIDSource::Enum securityIdSource ( )
inlinestaticconstexprnoexcept

Identifies the class of the SecurityID (Exchange Symbol).

Definition at line 18054 of file Messages.h.

◆ securityReqId()

SecurityReqRespID securityReqId ( ) const
inlinenoexcept

Unique ID of a Security Definition Request.

Definition at line 18002 of file Messages.h.

◆ securityResponseId()

SecurityReqRespID securityResponseId ( ) const
inlinenoexcept

Unique ID of a Security Definition message.

Definition at line 18157 of file Messages.h.

◆ securityResponseType()

SecurityResponseType::Enum securityResponseType ( ) const
inlinenoexcept

Type of Security Definition message response.

Definition at line 18075 of file Messages.h.

◆ securityStrategyType()

bool securityStrategyType ( StrRef & value) const
inlinenoexcept

Indicates the type of Strategy created. This field is not sent on rejects.

Definition at line 18098 of file Messages.h.

◆ senderLocation()

StrRef senderLocation ( ) const
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 18177 of file Messages.h.

◆ setEnteringTrader()

ThisType & setEnteringTrader ( StrRef value)
inlinenoexcept

Identifies the trader who is inserting an order.

Definition at line 18209 of file Messages.h.

◆ setSecurityId()

ThisType & setSecurityId ( SecurityIDOptional value)
inlinenoexcept

Security identification as defined by exchange.

Definition at line 18033 of file Messages.h.

◆ setSecurityIdToNull()

ThisType & setSecurityIdToNull ( )
inlinenoexcept

Definition at line 18042 of file Messages.h.

◆ setSecurityReqId()

ThisType & setSecurityReqId ( SecurityReqRespID value)
inlinenoexcept

Unique ID of a Security Definition Request.

Definition at line 18011 of file Messages.h.

◆ setSecurityResponseId()

ThisType & setSecurityResponseId ( SecurityReqRespID value)
inlinenoexcept

Unique ID of a Security Definition message.

Definition at line 18166 of file Messages.h.

◆ setSecurityResponseType()

ThisType & setSecurityResponseType ( SecurityResponseType::Enum value)
inlinenoexcept

Type of Security Definition message response.

Definition at line 18085 of file Messages.h.

◆ setSecurityStrategyType()

ThisType & setSecurityStrategyType ( StrRef value)
inlinenoexcept

Indicates the type of Strategy created. This field is not sent on rejects.

Definition at line 18109 of file Messages.h.

◆ setSecurityStrategyTypeToNull()

ThisType & setSecurityStrategyTypeToNull ( )
inlinenoexcept

Definition at line 18119 of file Messages.h.

◆ setSenderLocation()

ThisType & setSenderLocation ( StrRef value)
inlinenoexcept

Identifies the original location for routing orders.

Definition at line 18187 of file Messages.h.

◆ setSymbol()

ThisType & setSymbol ( StrRef value)
inlinenoexcept

B3 requires that this field is properly set. It contains the human readable form of the SecurityID tag, available in the Security List message in Market Data feed.

Definition at line 18145 of file Messages.h.

◆ symbol()

StrRef symbol ( ) const
inlinenoexcept

B3 requires that this field is properly set. It contains the human readable form of the SecurityID tag, available in the Security List message in Market Data feed.

Definition at line 18133 of file Messages.h.

◆ tail()

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

Definition at line 18325 of file Messages.h.

◆ toString() [1/2]

std::string toString ( bool skipEmptyFields = false) const
inline
Returns
a human-readable presentation.

Definition at line 1793 of file MessageSerialization.h.

◆ toString() [2/2]

void toString ( std::string & dest,
bool skipEmptyFields = false )
inline

Writes a human-readable presentation into the destination string.

Definition at line 1786 of file MessageSerialization.h.