xrpl::detail::MessageHeader Struct Reference

#include <ProtocolMessage.h>

Collaboration diagram for xrpl::detail::MessageHeader:

Public Attributes
std::uint32_t	totalWireSize = 0
	The size of the message on the wire.
std::uint32_t	headerSize = 0
	The size of the header associated with this message.
std::uint32_t	payloadWireSize = 0
	The size of the payload on the wire.
std::uint32_t	uncompressedSize = 0
	Uncompressed message size if the message is compressed.
std::uint16_t	messageType = 0
	The type of the message.
compression::Algorithm	algorithm = compression::Algorithm::None
	Indicates which compression algorithm the payload is compressed with.

Detailed Description

Definition at line 95 of file ProtocolMessage.h.

Member Data Documentation

totalWireSize

std::uint32_t xrpl::detail::MessageHeader::totalWireSize = 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 101 of file ProtocolMessage.h.

headerSize

std::uint32_t xrpl::detail::MessageHeader::headerSize = 0

The size of the header associated with this message.

Definition at line 104 of file ProtocolMessage.h.

payloadWireSize

std::uint32_t xrpl::detail::MessageHeader::payloadWireSize = 0

The size of the payload on the wire.

Definition at line 107 of file ProtocolMessage.h.

uncompressedSize

std::uint32_t xrpl::detail::MessageHeader::uncompressedSize = 0

Uncompressed message size if the message is compressed.

Definition at line 110 of file ProtocolMessage.h.

messageType

std::uint16_t xrpl::detail::MessageHeader::messageType = 0

The type of the message.

Definition at line 113 of file ProtocolMessage.h.

algorithm

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

Indicates which compression algorithm the payload is compressed with.

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

Definition at line 119 of file ProtocolMessage.h.