esphome::packet_interface Namespace Reference

Data Structures
class	BasicSession
	A session layer that reports whether the peer can be reached. More...
class	HdlcReliability
	A reliability layer that delivers packets in order, without loss or duplicates, between two peers. More...
class	PacketBuffer
	A buffer class that efficiently represents a composite buffer with three sections: More...
class	PacketInterface
	A class that will transport data to and from an abstract channel. More...
class	PacketInterfaceTransport
	A transport protocol adapter that bridges PacketInterface to PacketTransport. More...
class	PacketMetaData
	A struct to hold metadata about a packet. More...
class	XxteaEncryption
	An encryption layer that encrypts and authenticates each packet with XXTEA and a 256-bit shared key. More...

Enumerations
enum	Capability : uint8_t {   CAPABILITY_ENCRYPTION = 1 << 0 , CAPABILITY_RELIABILITY = 1 << 1 , CAPABILITY_SESSION = 1 << 2 , CAPABILITY_ADDRESSING = 1 << 3 ,   CAPABILITY_FRAGMENTATION = 1 << 4 }
	What a stack of layers provides, as bits of PacketInterface::get_capabilities(). More...

Functions
	ESPHOME_LOG_TAG (TAG, "packet_interface.session")
	ESPHOME_LOG_TAG (TAG, "packet_interface.hdlc")
	ESPHOME_LOG_TAG (TAG, "packet_interface")
constexpr size_t	remaining_packet_size (size_t size, size_t used)
	The room left for a packet of size bytes after used bytes, or 0 if it is too small.
	ESPHOME_LOG_TAG (TAG, "packet_interface.transport")
	ESPHOME_LOG_TAG (TAG, "packet_interface.xxtea")

Enumeration Type Documentation

Capability

enum esphome::packet_interface::Capability : uint8_t

What a stack of layers provides, as bits of PacketInterface::get_capabilities().

Enumerator
CAPABILITY_ENCRYPTION
CAPABILITY_RELIABILITY
CAPABILITY_SESSION
CAPABILITY_ADDRESSING
CAPABILITY_FRAGMENTATION

Definition at line 19 of file packet_interface.h.

Function Documentation

ESPHOME_LOG_TAG() [1/5]

esphome::packet_interface::ESPHOME_LOG_TAG	(	TAG	,
		"packet_interface"	)

ESPHOME_LOG_TAG() [2/5]

esphome::packet_interface::ESPHOME_LOG_TAG	(	TAG	,
		"packet_interface.hdlc"	)

ESPHOME_LOG_TAG() [3/5]

esphome::packet_interface::ESPHOME_LOG_TAG	(	TAG	,
		"packet_interface.session"	)

ESPHOME_LOG_TAG() [4/5]

esphome::packet_interface::ESPHOME_LOG_TAG	(	TAG	,
		"packet_interface.transport"	)

ESPHOME_LOG_TAG() [5/5]

esphome::packet_interface::ESPHOME_LOG_TAG	(	TAG	,
		"packet_interface.xxtea"	)

remaining_packet_size()

size_t esphome::packet_interface::remaining_packet_size ( size_t size, size_t used )

constexpr

The room left for a packet of size bytes after used bytes, or 0 if it is too small.

Definition at line 16 of file packet_interface.h.