Overview

template<size_t kSizeBytes>
class pw::hdlc::DecoderBuffer< kSizeBytes >

Declares a buffer along with a Decoder.

Inheritance diagram for pw::hdlc::DecoderBuffer< kSizeBytes >:

Public Member Functions
	DecoderBuffer (DecoderBuffer &&)=delete

DecoderBuffer &	operator= (DecoderBuffer &&)=delete

Public Member Functions inherited from pw::hdlc::Decoder
constexpr	Decoder (ByteSpan buffer)

	Decoder (const Decoder &)=delete

Decoder &	operator= (const Decoder &)=delete

	Decoder (Decoder &&)=default

Decoder &	operator= (Decoder &&)=default

Result< Frame >	Process (std::byte new_byte)
	Parses a single byte of an HDLC stream.

template<typename F , typename... Args>
void	Process (ConstByteSpan data, F &&callback, Args &&... args)
	Processes a span of data and calls the provided callback with each frame or error.

size_t	max_size () const

void	Clear ()
	Clears and resets the decoder.

Static Public Member Functions
static constexpr size_t	max_size ()

Static Public Member Functions inherited from pw::hdlc::Decoder
static constexpr size_t	RequiredBufferSizeForFrameSize (size_t max_frame_size)

Constructor & Destructor Documentation

template<size_t kSizeBytes>

pw::hdlc::DecoderBuffer< kSizeBytes >::DecoderBuffer ( DecoderBuffer< kSizeBytes > && )

delete

DecoderBuffer is not movable, as the decoder stores pointers into the frame buffer.

template<size_t kSizeBytes>

static constexpr size_t pw::hdlc::DecoderBuffer< kSizeBytes >::max_size ( )

inlinestaticconstexpr

Returns: The maximum length of the bytes that can be inserted into the bytes buffer.

template<size_t kSizeBytes>

DecoderBuffer & pw::hdlc::DecoderBuffer< kSizeBytes >::operator= ( DecoderBuffer< kSizeBytes > && )

delete

DecoderBuffer is not movable, as the decoder stores pointers into the frame buffer.

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