rippled
Public Attributes | List of all members
ripple::detail::MessageHeader Struct Reference
Collaboration diagram for ripple::detail::MessageHeader:
Collaboration graph
[legend]

Public Attributes

std::uint32_t total_wire_size = 0
 The size of the message on the wire. More...
 
std::uint32_t header_size = 0
 The size of the header associated with this message. More...
 
std::uint32_t payload_wire_size = 0
 The size of the payload on the wire. More...
 
std::uint32_t uncompressed_size = 0
 Uncompressed message size if the message is compressed. More...
 
std::uint16_t message_type = 0
 The type of the message. More...
 
compression::Algorithm algorithm = compression::Algorithm::None
 Indicates which compression algorithm the payload is compressed with. More...
 

Detailed Description

Definition at line 124 of file ProtocolMessage.h.

Member Data Documentation

◆ total_wire_size

std::uint32_t ripple::detail::MessageHeader::total_wire_size = 0

The size of the message on the wire.

Note
This is the sum of sizes of the header and the payload.

Definition at line 130 of file ProtocolMessage.h.

◆ header_size

std::uint32_t ripple::detail::MessageHeader::header_size = 0

The size of the header associated with this message.

Definition at line 133 of file ProtocolMessage.h.

◆ payload_wire_size

std::uint32_t ripple::detail::MessageHeader::payload_wire_size = 0

The size of the payload on the wire.

Definition at line 136 of file ProtocolMessage.h.

◆ uncompressed_size

std::uint32_t ripple::detail::MessageHeader::uncompressed_size = 0

Uncompressed message size if the message is compressed.

Definition at line 139 of file ProtocolMessage.h.

◆ message_type

std::uint16_t ripple::detail::MessageHeader::message_type = 0

The type of the message.

Definition at line 142 of file ProtocolMessage.h.

◆ algorithm

compression::Algorithm ripple::detail::MessageHeader::algorithm = compression::Algorithm::None

Indicates which compression algorithm the payload is compressed with.

Currenly only lz4 is supported. If None then the message is not compressed.

Definition at line 148 of file ProtocolMessage.h.