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

A request that indicates a client is attempting to create a new session. More...

#include <messages.hpp>

Public Member Functions

 LoginRequest (SequenceNumber sequence, Username username_, Password password_)
 Initialize a new login request. More...
 
std::string username_string () const
 Return a string representation of the user-name for the account.
 
std::string password_string () const
 Return a string representation of the password for the account.
 
std::string to_string () const
 Convert the object to an STL string. More...
 

Public Attributes

const Header header
 the header for the message
 
const Username username
 the user name of the connecting client
 
const Password password
 the password for the connecting client
 

Friends

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

Detailed Description

A request that indicates a client is attempting to create a new session.

Login Request

Constructor & Destructor Documentation

◆ LoginRequest()

OrderEntry::Messages::LoginRequest::LoginRequest ( SequenceNumber  sequence,
Username  username_,
Password  password_ 
)
inline

Initialize a new login request.

Parameters
sequencethe sequence of the message in event time
username_the username for the connecting client
password_the password for the connecting client

Member Function Documentation

◆ to_string()

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