OnixS C++ CME iLink 3 Binary Order Entry Handler  1.12.0
API Documentation
SBE Message

Inner Contents

 Message Fields
 Repeating Groups
 Schema Versioning

Detailed Description

The OnixS::CME::iLink3::Messaging::SbeMessage represents a Simple Binary Encoding (SBE) message. The details about SBE can be found at the iLink 3 - Simple Binary Encoding page.

MessageHolder class

The Handler exposes the OnixS::CME::iLink3::Messaging::MessageHolder class to encapsulate services related to handling SBE messages. It is a template class, which creates an underlying buffer to store an SBE message.

The template parameter SbeMessageType serves to indicate how the underlying buffer will be interpreted and what type of SBE message it will store.

The OnixS::CME::iLink3::Messaging::MessageHolder class contains the OnixS::CME::iLink3::Messaging::SimpleOpenFramingHeader and a strongly typed SBE message over the underlying data buffer.

To access to the strongly typed SBE message, use the OnixS::CME::iLink3::Messaging::MessageHolder::message method or OnixS::CME::iLink3::Messaging::MessageHolder::operator->().

Strongly Typed SBE Message Wrappers

The Handler exposes strongly typed SBE message wrappers (e.g.: OnixS::CME::iLink3::Messaging::NewOrderSingle514), which provide interfaces to manipulate SBE message fields. These wrappers are used in strongly typed inbound callbacks of the OnixS::CME::iLink3::SessionListener class (e.g.: OnixS::CME::iLink3::SessionListener::onExecutionReportNew(const Messaging::ExecutionReportNew522 &, Session *)).

Strongly typed SBE message wrapper classes do not have an underlying buffer and work only over an external buffer. Therefore, one needs to make sure that the lifetime of a strongly typed SBE message class object is the same as the lifetime of the buffer. For example, one should not use the delivered strongly typed SBE message object outside the inbound callback, since it uses an internal receiving buffer.

Constructing SBE Message

To create an SBE message object, use the OnixS::CME::iLink3::Messaging::MessageHolder constructor. It creates the underlying buffer and the strongly typed message wrapper around it.

For example:

The following example demonstrates how SBE messages can be created.

using namespace OnixS::CME::iLink3;
// Constructs a "New Order - Single" message,
// optional field values are set to their `null` values,
// required field values are undefined.
typedef MessageHolder<NewOrderSingle514> NewOrderSingle;
NewOrderSingle order;
std::cout << "Order " << *order << std::endl;
By default, the OnixS::CME::iLink3::Messaging::MessageHolder constructor sets optional fields to their null values, required field values are undefined. This behavior could be changed using the OnixS::CME::iLink3::Messaging::FieldsNoInitPolicy template argument.

For example:

using namespace OnixS::CME::iLink3;
// Constructs a "New Order - Single" message, both requird and optional field values are undefined.
FieldsNoInitPolicy> NewOrderSingle;
NewOrderSingle order;
std::cout << "Order " << *order << std::endl;