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

A response describing the status of canceling all active orders in the book. More...

#include <messages.hpp>

Public Member Functions

 PurgeResponse (SequenceNumber sequence, PurgeStatus status_)
 Initialize a new purge response 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 PurgeStatus status
 whether the purge was accepted
 

Friends

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

Detailed Description

A response describing the status of canceling all active orders in the book.

Purge Response

Constructor & Destructor Documentation

◆ PurgeResponse()

OrderEntry::Messages::PurgeResponse::PurgeResponse ( SequenceNumber  sequence,
PurgeStatus  status_ 
)
inline

Initialize a new purge response message.

Parameters
sequencethe sequence number for the message
status_the status of the cancellation response

Member Function Documentation

◆ to_string()

std::string OrderEntry::Messages::PurgeResponse::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 PurgeResponse 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: