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

A request to cancel all active orders in the book. More...

#include <messages.hpp>

Public Member Functions

 PurgeRequest (SequenceNumber sequence)
 Initialize a new purge 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
 

Friends

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

Detailed Description

A request to cancel all active orders in the book.

Purge Request

Constructor & Destructor Documentation

◆ PurgeRequest()

OrderEntry::Messages::PurgeRequest::PurgeRequest ( SequenceNumber  sequence)
inlineexplicit

Initialize a new purge request message.

Parameters
sequencethe sequence number for the message

Member Function Documentation

◆ to_string()

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