itch::overlay::OrderCancelView Class Reference

Lazy view of an Order Cancel (X) message. More...

#include <overlay.hpp>

Inheritance diagram for itch::overlay::OrderCancelView:

Public Member Functions
auto	order_reference_number () const noexcept -> std::uint64_t
	Reference number of the cancelled order.
auto	cancelled_shares () const noexcept -> std::uint32_t
	Number of shares cancelled.
constexpr	MessageView () noexcept=default
	Constructs an empty view with no underlying frame.
	MessageView (const std::byte *data, std::size_t size) noexcept
	Constructs a view over a raw ITCH message frame.
Public Member Functions inherited from itch::overlay::MessageView
constexpr	MessageView () noexcept=default
	Constructs an empty view with no underlying frame.
	MessageView (const std::byte *data, std::size_t size) noexcept
	Constructs a view over a raw ITCH message frame.
auto	type () const noexcept -> char
	The one-byte message type.
auto	stock_locate () const noexcept -> std::uint16_t
	The locate code identifying the security.
auto	tracking_number () const noexcept -> std::uint16_t
	The Nasdaq internal tracking number.
auto	timestamp () const noexcept -> std::uint64_t
	The message timestamp (nanoseconds past midnight).
auto	size () const noexcept -> std::size_t
	The raw frame size in bytes.
auto	data () const noexcept -> const std::byte *
	Pointer to the raw frame (the type byte).
template<typename FieldType >
auto	read (std::size_t offset) const noexcept -> FieldType
	Reads an arbitrary integral field at a byte offset, big-endian.

Additional Inherited Members
Protected Attributes inherited from itch::overlay::MessageView
const std::byte *	m_data {nullptr}
std::size_t	m_size {0}

Detailed Description

Lazy view of an Order Cancel (X) message.

Definition at line 237 of file overlay.hpp.

Member Function Documentation

order_reference_number()

auto itch::overlay::OrderCancelView::order_reference_number ( ) const -> std::uint64_t

inlinenoexcept

Reference number of the cancelled order.

Returns

Reference number of the cancelled order.

Definition at line 243 of file overlay.hpp.

cancelled_shares()

auto itch::overlay::OrderCancelView::cancelled_shares ( ) const -> std::uint32_t

inlinenoexcept

Number of shares cancelled.

Returns

Number of shares cancelled.

Definition at line 249 of file overlay.hpp.

MessageView() [1/2]

constexpr itch::overlay::MessageView::MessageView ( )

constexprdefaultnoexcept

Constructs an empty view with no underlying frame.

MessageView() [2/2]

itch::overlay::MessageView::MessageView ( const std::byte *  data, std::size_t  size  )

inlineexplicitnoexcept

Constructs a view over a raw ITCH message frame.

Parameters

data	Pointer to the start of the frame (the type byte).
size	Size of the frame in bytes.

Definition at line 97 of file overlay.hpp.

---

The documentation for this class was generated from the following file:

• overlay.hpp