HDLCStream Class Reference

High-Level Data Link Control (HDLC) is a bit-oriented code-transparent synchronous data link layer protocol. More...

#include <HDLCStream.h>

Inheritance diagram for HDLCStream:

Public Member Functions
	HDLCStream (Print &out, uint16_t max_frame_length)
	Defines the output for the hdlc encoding.
	HDLCStream (Stream &io, uint16_t max_frame_length)
	Defines the input for the hdlc decoding.
int	available () override
int	availableForWrite () override
bool	begin ()
void	end ()
virtual void	flush ()
	operator bool ()
int	peek () override
	not supported
int	read () override
size_t	readBytes (uint8_t *data, size_t len) override
	Provides the decoded data.
void	setOutput (Print &out)
void	setStream (Print &out)
void	setStream (Stream &io)
size_t	write (const uint8_t *data, size_t len) override
	Sends the encoded data to the defined output.
size_t	write (uint8_t ch) override

Protected Attributes
int	_timeout = 10

Detailed Description

High-Level Data Link Control (HDLC) is a bit-oriented code-transparent synchronous data link layer protocol.

Member Function Documentation

available()

int available ( )

inlineoverridevirtual

Reimplemented from Stream.

availableForWrite()

int availableForWrite ( )

inlineoverridevirtual

Reimplemented from Print.

flush()

virtual void flush ( )

inlinevirtualinherited

Reimplemented in ResampleStream, BufferedTaskStream, and BufferedStream.

readBytes()

size_t readBytes ( uint8_t *  data, size_t  len  )

inlineoverridevirtual

Provides the decoded data.

Reimplemented from Stream.

write()

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtual

Sends the encoded data to the defined output.

Reimplemented from Print.

---

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

• src/AudioTools/Sandbox/HDLCStream.h