Member Function Documentation

MessageTransportHeader &MessagePacket::GetHeader()

Retrieves the MessageTransportHeader of the packet.

Returns a reference to the MessageTransportHeader of the packet.

const MessageTransportHeader &MessagePacket::GetHeader() const

Retrieves the MessageTransportHeader of the packet.

Returns a constant reference to the MessageTransportHeader of the packet.

Message &MessagePacket::GetMessage()

Retrieves the Message of the packet.

Returns a reference to the Message of the packet.

const Message &MessagePacket::GetMessage() const

Retrieves the Message of the packet.

Returns a constant reference to the Message of the packet.

T &MessagePacket::GetMessage()

const T &MessagePacket::GetMessage() const

std::ostream &MessagePacket::GetPayloadOStream()

Retrieves an output stream for appending data to the payload.

Streaming data to the ostream updates Message Payload Size to new payload size. Returns an output stream for appending data directly to the payload buffer

void MessagePacket::Init()

const std::string_view MessagePacket::Payload() const

Retrieves the payload as a string view.

Returns a string view of the payload.

const std::string_view MessagePacket::Payload() const

void MessagePacket::PayloadAppend(const std::string &data)

Appends data to the payload.

Updates Message Payload Size to new payload size. data The data to append to the payload.

char *MessagePacket::PayloadData() const

Retrieves the data of the payload.

Returns a pointer to the data of the payload.

size_t MessagePacket::PayloadSize() const

Retrieves the size of the payload.

Returns the size of the payload.

size_t MessagePacket::RawCapacity() const

Retrieves the number of bytes of the raw data buffer available before memory reallocation Returns the capasity of the raw data buffer.

char *MessagePacket::RawData() const

size_t MessagePacket::RawSize() const

Retrieves the size of the raw data buffer. Data buffer holding MessageTransportHeader + Message + Payload Returns the size of the raw data buffer.

void MessagePacket::ReserveRaw(size_t rawSize = 0)

Reserves the raw data buffer to a specified size.

Reserving makes following writes via PayloadAppend() or stream to GetPayloadOStream() faster.

rawSize The new reserved (internally allocated) size for the raw data buffer.

void MessagePacket::Reset()

Resets the message packet to its initial state.

void MessagePacket::ResizeMessage(size_t messageSize = 0)

Resizes packet to fit custom message header and payload of message. Room for MessageTransportHeader is automatically allocated.

param messageSize equals Message header + payload

void MessagePacket::ResizeRaw(size_t rawSize = 0)

Resizes the raw data buffer to a specified size.

Data buffer for holding MessageTransportHeader + Message + Payload Also updates Message Payload Size to new size left over from default headers MessageTransportHeader + Message

rawSize The new size for the raw data buffer.