b2bits::nasdaq::soupbintcp::PacketHeader Class Reference

SoupBinTCP packet header. More...

Detailed Description

SoupBinTCP packet header.

Common header for all SoupBinTCP packets. Contains the packet length (excluding the length field itself) and a single-character packet type discriminator.

Wire format (3 bytes):

• Length (2 bytes): Packet length excluding length field (network byte order)
• Packet Type (1 byte): ASCII character identifying packet type

Note

All multi-byte fields are in network byte order (big-endian)

Length field does NOT include itself (2 bytes)

#include <nasdaq/soupbintcp/Messages.h>

Inheritance diagram for b2bits::nasdaq::soupbintcp::PacketHeader:

Public Member Functions
	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.

Constructor & Destructor Documentation

PacketHeader() [1/2]

b2bits::nasdaq::soupbintcp::PacketHeader::PacketHeader ( )

default

Default constructor.

Referenced by b2bits::nasdaq::soupbintcp::ClientHeartbeat::ClientHeartbeat(), b2bits::nasdaq::soupbintcp::DebugPacket::DebugPacket(), b2bits::nasdaq::soupbintcp::EndOfSession::EndOfSession(), b2bits::nasdaq::soupbintcp::LoginAccepted::LoginAccepted(), b2bits::nasdaq::soupbintcp::LoginReject::LoginReject(), b2bits::nasdaq::soupbintcp::LoginRequest::LoginRequest(), b2bits::nasdaq::soupbintcp::LogoutRequest::LogoutRequest(), b2bits::nasdaq::soupbintcp::SequencedData::SequencedData(), b2bits::nasdaq::soupbintcp::ServerHeartbeat::ServerHeartbeat(), and b2bits::nasdaq::soupbintcp::UnsequencedData::UnsequencedData().

PacketHeader() [2/2]

b2bits::nasdaq::soupbintcp::PacketHeader::PacketHeader ( Alpha type, UInt16 len )

inline

Construct packet header with type and length.

Parameters

type	Packet type character
len	Total packet length including length field

Member Function Documentation

get_message_length()

UInt16 b2bits::nasdaq::soupbintcp::PacketHeader::get_message_length ( ) const

inline

Get total message length including length field.

Returns

Total packet size in bytes (host byte order)

get_packet_type()

Alpha b2bits::nasdaq::soupbintcp::PacketHeader::get_packet_type ( ) const

inline

Get packet type.

Returns

Packet type character

set_message_length()

void b2bits::nasdaq::soupbintcp::PacketHeader::set_message_length ( UInt16 val )

inline

Set message length.

Parameters

val	Total packet length including length field (host byte order)

set_packet_type()

void b2bits::nasdaq::soupbintcp::PacketHeader::set_packet_type ( Alpha val )

inline

Set packet type.

Parameters

val	Packet type character

---

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

• nasdaq/soupbintcp/Messages.h