OnixS C++ CME iLink 3 Binary Order Entry Handler  1.17.0
API Documentation
OrderCancelRequest516 Struct Reference

#include <OnixS/CME/iLink3/messaging/Messages.h>

Public Types

enum  { TemplateId = 516 }
 
typedef SchemaTraits Schema
 
typedef OrderCancelRequest516 ThisType
 
- Public Types inherited from SbeMessage
typedef MessageSize EncodedLength
 
typedef MessageSize BlockLength
 

Public Member Functions

 OrderCancelRequest516 ()=default
 
 OrderCancelRequest516 (void *data, EncodedLength length, SchemaVersion version=Schema::Version)
 
 OrderCancelRequest516 (void *data, EncodedLength length, NoFieldsInit, SchemaVersion version=Schema::Version)
 
 OrderCancelRequest516 (void *data, EncodedLength length, NoInit)
 
 OrderCancelRequest516 (const SbeMessage &message)
 
 OrderCancelRequest516 (void *data, EncodedLength length, NoInit, NoCheck) noexcept
 
bool orderId (UInt64 &value) const noexcept
 
ThisTypesetOrderId (UInt64 value) noexcept
 
ThisTypesetOrderIdToNull () noexcept
 
UInt64 partyDetailsListReqId () const noexcept
 
ThisTypesetPartyDetailsListReqId (UInt64 value) noexcept
 
ManualOrdIndReq::Enum manualOrderIndicator () const noexcept
 
ThisTypesetManualOrderIndicator (ManualOrdIndReq::Enum value) noexcept
 
UInt32 seqNum () const noexcept
 
ThisTypesetSeqNum (UInt32 value) noexcept
 
StrRef senderId () const noexcept
 
ThisTypesetSenderId (StrRef value) noexcept
 
StrRef clOrdId () const noexcept
 
ThisTypesetClOrdId (StrRef value) noexcept
 
UInt64 orderRequestId () const noexcept
 
ThisTypesetOrderRequestId (UInt64 value) noexcept
 
UInt64 sendingTimeEpoch () const noexcept
 
ThisTypesetSendingTimeEpoch (UInt64 value) noexcept
 
StrRef location () const noexcept
 
ThisTypesetLocation (StrRef value) noexcept
 
Int32 securityId () const noexcept
 
ThisTypesetSecurityId (Int32 value) noexcept
 
SideReq::Enum side () const noexcept
 
ThisTypesetSide (SideReq::Enum value) noexcept
 
bool liquidityFlag (BooleanNULL::Enum &value) const noexcept
 
ThisTypesetLiquidityFlag (BooleanNULL::Enum value) noexcept
 
ThisTypesetLiquidityFlagToNull () noexcept
 
bool origOrderUser (StrRef &value) const noexcept
 
ThisTypesetOrigOrderUser (StrRef value) noexcept
 
ThisTypesetOrigOrderUserToNull () 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
 
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 (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 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)
 
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
 
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 6649 of file Messages.h.

Member Typedef Documentation

Used template schema.

Definition at line 6654 of file Messages.h.

This type alias.

Definition at line 6657 of file Messages.h.

Member Enumeration Documentation

anonymous enum

Message template ID from SBE schema.

Enumerator
TemplateId 

Definition at line 6660 of file Messages.h.

Constructor & Destructor Documentation

OrderCancelRequest516 ( )
default

Initializes a blank instance.

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

Initializes an instance over the given memory block.

Definition at line 6666 of file Messages.h.

OrderCancelRequest516 ( 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 6681 of file Messages.h.

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

Creates an instance over the given memory block.

Definition at line 6695 of file Messages.h.

OrderCancelRequest516 ( const SbeMessage message)
inlineexplicit

Creates an instance over the given SBE message.

Definition at line 6706 of file Messages.h.

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

Creates an instance over the given memory block.

Performs no checks.

Definition at line 6717 of file Messages.h.

Member Function Documentation

static constexpr BlockLength blockLength ( SchemaVersion  version)
inlinestaticnoexcept

Size of message body in bytes.

Definition at line 7099 of file Messages.h.

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

Definition at line 7190 of file Messages.h.

static constexpr const Char* className ( )
inlinestatic
Returns
class name.

Definition at line 7156 of file Messages.h.

StrRef clOrdId ( ) const
inlinenoexcept

Unique identifier for Order as assigned by the buy-side (institution, broker, intermediary etc.).

Uniqueness must be guaranteed within a single trading day. Firms, particularly those which electronically submit multi-day orders, trade globally or throughout market close periods, should ensure uniqueness across days, for example by embedding a date within the ClOrdID field.

Definition at line 6873 of file Messages.h.

static constexpr StrRef fixType ( )
inlinestaticnoexcept

FIX message type.

Definition at line 7165 of file Messages.h.

static constexpr UInt64 getMaxMessageSize ( UInt8  )
inlinestaticnoexcept

Maximal message size.

Definition at line 7125 of file Messages.h.

static constexpr MessageSize getMinimalVariableFieldsSize ( SchemaVersion  version)
inlinestatic

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

Definition at line 7113 of file Messages.h.

bool liquidityFlag ( BooleanNULL::Enum value) const
inlinenoexcept

Field added to capture if an order was submitted for market making obligation or not.

Applicable only for EU BrokerTec and EBS MiFID regulated instruments.

Definition at line 7019 of file Messages.h.

StrRef location ( ) const
inlinenoexcept

Text describing sender's location (i.e.

geopraphic location and/or desk).

Definition at line 6948 of file Messages.h.

ManualOrdIndReq::Enum manualOrderIndicator ( ) const
inlinenoexcept

Indicates if the order was initially received manually (as opposed to electronically).

Definition at line 6790 of file Messages.h.

static constexpr BlockLength minimalBlockLength ( SchemaVersion  version)
inlinestaticnoexcept

Minimal size of message body in bytes.

Definition at line 7087 of file Messages.h.

bool orderId ( UInt64 value) const
inlinenoexcept

Unique identifier for order as assigned by the exchange.

Uniqueness is guaranteed within a single trading day across all instruments.

Definition at line 6734 of file Messages.h.

UInt64 orderRequestId ( ) const
inlinenoexcept

Use OrderRequestID to identify a request to enter, modify or delete an order and echo the value on the ExecutionReport representing the response.

Definition at line 6903 of file Messages.h.

bool origOrderUser ( StrRef value) const
inlinenoexcept

Represents the original sender comp for whom orders or quotes are to be cancelled.

Definition at line 7051 of file Messages.h.

UInt64 partyDetailsListReqId ( ) const
inlinenoexcept

Refers to the ID of the related PartyDetailsDefinitionRequest message which will logically be tied to this message.

Definition at line 6767 of file Messages.h.

ThisType& reset ( )
inlinenoexcept

Reset all variable-length and optional fields if any.

Definition at line 7141 of file Messages.h.

ThisType& resetVariableFields ( )
inlinenoexcept

Reset all variable-length fields if any.

Definition at line 7134 of file Messages.h.

Int32 securityId ( ) const
inlinenoexcept

Security ID as defined by CME.

For the security ID list, see the security definition messages. Falcon ignores the incoming value except when null and returns back the correct one in the outgoing execution report.

Definition at line 6974 of file Messages.h.

StrRef senderId ( ) const
inlinenoexcept

Operator ID.

Should be unique per Firm ID. Assigned value used to identify specific message originator. Represents last individual or team in charge of the system which modifies the order before submission to the Globex platform, or if not modified from initiator (party role=118), last individual or team in charge of the system, which submit the order to the Globex platform.

Definition at line 6839 of file Messages.h.

UInt64 sendingTimeEpoch ( ) const
inlinenoexcept

Time when the message is sent.

64-bit integer expressing the number of nano seconds since midnight January 1, 1970.

Definition at line 6926 of file Messages.h.

UInt32 seqNum ( ) const
inlinenoexcept

Sequence number as assigned to message.

Definition at line 6813 of file Messages.h.

ThisType& setClOrdId ( StrRef  value)
inlinenoexcept

Unique identifier for Order as assigned by the buy-side (institution, broker, intermediary etc.).

Uniqueness must be guaranteed within a single trading day. Firms, particularly those which electronically submit multi-day orders, trade globally or throughout market close periods, should ensure uniqueness across days, for example by embedding a date within the ClOrdID field.

Definition at line 6889 of file Messages.h.

ThisType& setLiquidityFlag ( BooleanNULL::Enum  value)
inlinenoexcept

Field added to capture if an order was submitted for market making obligation or not.

Applicable only for EU BrokerTec and EBS MiFID regulated instruments.

Definition at line 7030 of file Messages.h.

ThisType& setLiquidityFlagToNull ( )
inlinenoexcept

Definition at line 7039 of file Messages.h.

ThisType& setLocation ( StrRef  value)
inlinenoexcept

Text describing sender's location (i.e.

geopraphic location and/or desk).

Definition at line 6959 of file Messages.h.

ThisType& setManualOrderIndicator ( ManualOrdIndReq::Enum  value)
inlinenoexcept

Indicates if the order was initially received manually (as opposed to electronically).

Definition at line 6801 of file Messages.h.

ThisType& setOrderId ( UInt64  value)
inlinenoexcept

Unique identifier for order as assigned by the exchange.

Uniqueness is guaranteed within a single trading day across all instruments.

Definition at line 6745 of file Messages.h.

ThisType& setOrderIdToNull ( )
inlinenoexcept

Definition at line 6754 of file Messages.h.

ThisType& setOrderRequestId ( UInt64  value)
inlinenoexcept

Use OrderRequestID to identify a request to enter, modify or delete an order and echo the value on the ExecutionReport representing the response.

Definition at line 6914 of file Messages.h.

ThisType& setOrigOrderUser ( StrRef  value)
inlinenoexcept

Represents the original sender comp for whom orders or quotes are to be cancelled.

Definition at line 7062 of file Messages.h.

ThisType& setOrigOrderUserToNull ( )
inlinenoexcept

Definition at line 7072 of file Messages.h.

ThisType& setPartyDetailsListReqId ( UInt64  value)
inlinenoexcept

Refers to the ID of the related PartyDetailsDefinitionRequest message which will logically be tied to this message.

Definition at line 6778 of file Messages.h.

ThisType& setSecurityId ( Int32  value)
inlinenoexcept

Security ID as defined by CME.

For the security ID list, see the security definition messages. Falcon ignores the incoming value except when null and returns back the correct one in the outgoing execution report.

Definition at line 6986 of file Messages.h.

ThisType& setSenderId ( StrRef  value)
inlinenoexcept

Operator ID.

Should be unique per Firm ID. Assigned value used to identify specific message originator. Represents last individual or team in charge of the system which modifies the order before submission to the Globex platform, or if not modified from initiator (party role=118), last individual or team in charge of the system, which submit the order to the Globex platform.

Definition at line 6855 of file Messages.h.

ThisType& setSendingTimeEpoch ( UInt64  value)
inlinenoexcept

Time when the message is sent.

64-bit integer expressing the number of nano seconds since midnight January 1, 1970.

Definition at line 6936 of file Messages.h.

ThisType& setSeqNum ( UInt32  value)
inlinenoexcept

Sequence number as assigned to message.

Definition at line 6822 of file Messages.h.

ThisType& setSide ( SideReq::Enum  value)
inlinenoexcept

Side of order.

Definition at line 7006 of file Messages.h.

SideReq::Enum side ( ) const
inlinenoexcept

Side of order.

Definition at line 6997 of file Messages.h.

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

Definition at line 7177 of file Messages.h.

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

Definition at line 710 of file MessageSerialization.h.


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