Pothos::Packet Struct Reference

#include <Packet.hpp>

Public Member Functions
	Packet (void)
	Default constructor for Packet. More...

Public Attributes
BufferChunk	payload
ObjectKwargs	metadata
std::vector< Label >	labels

Detailed Description

The Packet type is a general-purpose structure for asynchronous messages. A Packet contains a payload buffer with associated metadata and labels. Ideally, the Packet structure is a suitable container for most situations.

Constructor & Destructor Documentation

Pothos::Packet::Packet

(

void

)

Default constructor for Packet.

Member Data Documentation

std::vector<Label> Pothos::Packet::labels

Labels associated with the payload. Each label index is an element-offset relative to the start of the payload. The element size can be determined from the type of the payload buffer.

ObjectKwargs Pothos::Packet::metadata

Arbitrary metadata for this message. Use metadata to associate arbitrary information with the payload. The are no specific requirements about what goes into metadata. The metadata structure is a dictionary of key-value pairs, where the keys for this dictionary are exclusively strings, and the values are opaque Objects which can contain anything.

BufferChunk Pothos::Packet::payload

The buffer payload for this message. The payload is just a memory buffer and a length in bytes. Payload can contains a slice of a continuous byte stream, a UDP datagram, a packet in a MAC layer protocol, etc... The interpretation of this payload buffer is up to the user.

---

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

• include/Pothos/Framework/Packet.hpp