b2bits::nasdaq::soupbintcp::LoginRequest Class Reference

Login request packet ('L'). More...

Detailed Description

Login request packet ('L').

Sent by client to initiate a session. Contains authentication credentials and optionally a requested session ID and sequence number for session continuation.

Wire format (49 bytes):

• Header (3 bytes)
• Username (6 bytes): User identifier
• Password (10 bytes): Authentication password
• Requested Session (10 bytes): Session to continue (or spaces for new session)
• Requested Sequence Number (20 bytes): Starting sequence (or spaces for session start)

Note

Packet type: 'L'

#include <nasdaq/soupbintcp/Messages.h>

Inheritance diagram for b2bits::nasdaq::soupbintcp::LoginRequest:

Public Member Functions
	LoginRequest ()
	Construct a login request packet.
const FixedString< 6 > &	get_username () const
	Get username (const).
FixedString< 6 > &	get_username ()
	Get username (mutable).
const FixedString< 10 > &	get_password () const
	Get password (const).
FixedString< 10 > &	get_password ()
	Get password (mutable).
const FixedString< 10 > &	get_session () const
	Get requested session (const).
FixedString< 10 > &	get_session ()
	Get requested session (mutable).
const FixedString< 20 > &	get_sequence_number () const
	Get requested sequence number (const).
FixedString< 20 > &	get_sequence_number ()
	Get requested sequence number (mutable).
Public Member Functions inherited from b2bits::nasdaq::soupbintcp::PacketHeader
	PacketHeader ()=default
	Default constructor.
	PacketHeader (Alpha type, UInt16 len)
	Construct packet header with type and length.
UInt16	get_message_length () const
	Get total message length including length field.
void	set_message_length (UInt16 val)
	Set message length.
Alpha	get_packet_type () const
	Get packet type.
void	set_packet_type (Alpha val)
	Set packet type.

Static Public Attributes
static constexpr char	Type = 'L'
	Packet type identifier.

Constructor & Destructor Documentation

LoginRequest()

b2bits::nasdaq::soupbintcp::LoginRequest::LoginRequest ( )

inline

Construct a login request packet.

References b2bits::nasdaq::soupbintcp::PacketHeader::PacketHeader(), and Type.

Member Function Documentation

get_password() [1/2]

FixedString< 10 > & b2bits::nasdaq::soupbintcp::LoginRequest::get_password ( )

inline

Get password (mutable).

Returns

Reference to password (10 characters)

get_password() [2/2]

const FixedString< 10 > & b2bits::nasdaq::soupbintcp::LoginRequest::get_password ( ) const

inline

Get password (const).

Returns

Const reference to password (10 characters)

get_sequence_number() [1/2]

FixedString< 20 > & b2bits::nasdaq::soupbintcp::LoginRequest::get_sequence_number ( )

inline

Get requested sequence number (mutable).

Returns

Reference to sequence number (20 ASCII digits)

get_sequence_number() [2/2]

const FixedString< 20 > & b2bits::nasdaq::soupbintcp::LoginRequest::get_sequence_number ( ) const

inline

Get requested sequence number (const).

Returns

Const reference to sequence number (20 ASCII digits)

get_session() [1/2]

FixedString< 10 > & b2bits::nasdaq::soupbintcp::LoginRequest::get_session ( )

inline

Get requested session (mutable).

Returns

Reference to session (10 characters)

get_session() [2/2]

const FixedString< 10 > & b2bits::nasdaq::soupbintcp::LoginRequest::get_session ( ) const

inline

Get requested session (const).

Returns

Const reference to session (10 characters)

get_username() [1/2]

FixedString< 6 > & b2bits::nasdaq::soupbintcp::LoginRequest::get_username ( )

inline

Get username (mutable).

Returns

Reference to username (6 characters)

get_username() [2/2]

const FixedString< 6 > & b2bits::nasdaq::soupbintcp::LoginRequest::get_username ( ) const

inline

Get username (const).

Returns

Const reference to username (6 characters)

Member Data Documentation

Type

char b2bits::nasdaq::soupbintcp::LoginRequest::Type = 'L'

staticconstexpr

Packet type identifier.

Referenced by LoginRequest().

---

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

• nasdaq/soupbintcp/Messages.h