BaseStream Class Reference

Base class for all Streams. It relies on write(const uint8_t *buffer, size_t size) and readBytes(uint8_t *buffer, size_t length). More...

#include <BaseStream.h>

Inheritance diagram for BaseStream:

Collaboration diagram for BaseStream:

Public Member Functions
	BaseStream (BaseStream &)=default
BaseStream &	operator= (BaseStream &)=default
virtual bool	begin ()
virtual void	end ()
virtual size_t	readBytes (uint8_t *data, size_t len) STREAM_READ_OVERRIDE=0
virtual size_t	write (const uint8_t *data, size_t len) override=0
virtual size_t	write (uint8_t ch) override
virtual int	available ()
virtual int	availableForWrite ()
virtual void	flush () override
virtual size_t	readBytes (char *data, size_t len) STREAM_READCHAR_OVERRIDE
virtual int	read () override
virtual int	peek () override
void	setWriteBufferSize (int size)

Protected Member Functions
void	refillReadBuffer ()

Protected Attributes
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}
int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

Base class for all Streams. It relies on write(const uint8_t *buffer, size_t size) and readBytes(uint8_t *buffer, size_t length).

Author

Phil Schatzmann

Member Function Documentation

available()

virtual int available ( )

inlinevirtual

Reimplemented in UDPStream.

availableForWrite()

virtual int availableForWrite ( )

inlinevirtual

Reimplemented in UDPStream.

begin()

virtual bool begin ( )

inlinevirtual

Reimplemented in ESPNowStream.

end()

virtual void end ( )

inlinevirtual

Reimplemented in ESPNowStream.

readBytes()

virtual size_t readBytes ( uint8_t *  data, size_t  len  )

pure virtual

Implemented in ESPNowStream, and UDPStream.

write()

virtual size_t write ( const uint8_t *  data, size_t  len  )

overridepure virtual

Implemented in ESPNowStream, and UDPStream.

---

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

• src/TinyRobotics/utils/BaseStream.h