CBOE Emulator  1.0
Public Member Functions | Public Attributes | Friends | List of all members
OrderEntry::Messages::CancelRequest Struct Reference

A request to cancel an active limit order in the book. More...

#include <messages.hpp>

Public Member Functions

 CancelRequest (SequenceNumber sequence, OrderID order_id_)
 Initialize a new cancel request message. More...
 
std::string to_string () const
 Convert the object to an STL string. More...
 

Public Attributes

const Header header
 the header for the message
 
const OrderID order_id
 the order ID of the order to cancel
 

Friends

std::ostream & operator<< (std::ostream &stream, const CancelRequest &message)
 Write the data from the message to a stream. More...
 

Detailed Description

A request to cancel an active limit order in the book.

Cancel Request

Constructor & Destructor Documentation

◆ CancelRequest()

OrderEntry::Messages::CancelRequest::CancelRequest ( SequenceNumber  sequence,
OrderID  order_id_ 
)
inline

Initialize a new cancel request message.

Parameters
sequencethe sequence number for the message
order_id_the order ID of the order to cancel

Member Function Documentation

◆ to_string()

std::string OrderEntry::Messages::CancelRequest::to_string ( ) const
inline

Convert the object to an STL string.

Returns
a string representation of the object

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  stream,
const CancelRequest message 
)
friend

Write the data from the message to a stream.

Parameters
streamthe stream to write the data to
messagethe message to write to the stream
Returns
the stream with data from the message written to it

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