Base class for read/write stream. More...

#include <ReadWriteStream.h>

Inheritance diagram for ReadWriteStream:

Public Member Functions
size_t	write (uint8_t charToWrite) override
	Write a single character to the stream. More...

virtual size_t	write (const uint8_t *buffer, size_t size)=0
	Write chars to stream. More...

virtual StreamType	getStreamType () const
	Get the stream type. More...

virtual bool	isValid () const
	Determine if the stream object contains valid data. More...

virtual uint16_t	readMemoryBlock (char *data, int bufSize)=0
	Read a block of memory. More...

int	read () override
	Read one character and moves the stream pointer. More...

int	peek () override
	Read a character without advancing the stream pointer. More...

virtual bool	seek (int len)=0
	Move read cursor. More...

virtual bool	isFinished ()=0
	Check if all data has been read. More...

virtual int	available ()
	Return the total length of the stream. More...

size_t	write (const char *str)
	Writes a c-string to output stream. More...

size_t	write (const char *buffer, size_t size)
	Writes characters from a buffer to output stream. More...

int	length () SMING_DEPRECATED
	Return the total length of the stream. More...

void	flush () override

virtual String	id () const
	Returns unique id of the resource. More...

virtual String	getName () const
	Returns name of the resource. More...

void	setTimeout (unsigned long timeout)

bool	find (char *target)

bool	find (char *target, size_t length)

bool	findUntil (char target, char terminator)

bool	findUntil (char target, size_t targetLen, char terminate, size_t termLen)

long	parseInt ()

float	parseFloat ()

size_t	readBytes (char *buffer, size_t length)

size_t	readBytesUntil (char terminator, char *buffer, size_t length)

String	readString ()

String	readStringUntil (char terminator)

virtual int	indexOf (char c)

int	getWriteError ()
	Gets last error. More...

void	clearWriteError ()
	Clears the last write error. More...

size_t	print (char)
	Prints a single character to output stream. More...

size_t	print (const char[])
	Prints a c-string to output stream. More...

size_t	print (unsigned long, int base=DEC)
	Prints a number to output stream. More...

size_t	print (long, int base=DEC)
	Prints a number to output stream. More...

size_t	print (unsigned int, int base=DEC)

size_t	print (unsigned char, int base=DEC)

size_t	print (int, int base=DEC)
	Prints a number to output stream. More...

size_t	print (double, int digits=2)
	Prints number to output stream. More...

size_t	print (const Printable &p)
	Prints a Printable object to output stream. More...

size_t	print (const String &s)
	Prints a String to output stream. More...

size_t	println (void)
	Prints a newline to output stream. More...

size_t	println (const char[])
	Prints a c-string to output stream, appending newline. More...

size_t	println (char)
	Prints a single character to output stream, appending newline. More...

size_t	println (unsigned char, int base=DEC)
	Prints a number to output stream, appending newline. More...

size_t	println (unsigned int, int base=DEC)

size_t	println (unsigned long, int base=DEC)

size_t	println (int, int base=DEC)
	Prints a number to output stream, appending newline. More...

size_t	println (long, int base=DEC)
	Prints a number to output stream, appending newline. More...

size_t	println (double, int digits=2)
	Prints a number to output stream, appending newline. More...

size_t	println (const Printable &p)
	Prints a Printable object to output stream, appending newline. More...

size_t	println (const String &s)
	Prints a String to output stream, appending newline. More...

size_t	printf (const char *fmt,...)
	Prints a formatted c-string to output stream. More...

Protected Member Functions
int	timedRead ()

int	timedPeek ()

int	peekNextDigit ()

long	parseInt (char skipChar)

float	parseFloat (char skipChar)

void	setWriteError (int err=1)

Protected Attributes
unsigned long	receiveTimeout = 1000

unsigned long	startMillis = 0

Detailed Description

Base class for read/write stream.

Member Function Documentation

virtual int IDataSourceStream::available ( )

inlinevirtualinherited

Return the total length of the stream.

Return values

int	-1 is returned when the size cannot be determined

Implements Stream.

Reimplemented in HardwareSerial, FileStream, GdbFileStream, CircularBuffer, StreamTransformer, MemoryDataStream, JsonObjectStream, LimitedMemoryStream, UrlencodedOutputStream, FlashMemoryStream, MultiStream, and ArduCAMStream.

void Print::clearWriteError ( )

inlineinherited

Clears the last write error.

virtual String IDataSourceStream::getName ( ) const

inlinevirtualinherited

Returns name of the resource.

Return values

String

Note: Commonly used to obtain name of file

Reimplemented in TemplateStream, FileStream, and GdbFileStream.

virtual StreamType IDataSourceStream::getStreamType ( ) const

inlinevirtualinherited

Get the stream type.

Return values

StreamType The stream type.

Reimplemented in FileStream, TemplateStream, StreamTransformer, rBootItemOutputStream, CircularBuffer, MemoryDataStream, LimitedMemoryStream, EndlessMemoryStream, UrlencodedOutputStream, FlashMemoryStream, JsonObjectStream, MultiStream, and ArduCAMStream.

int Print::getWriteError ( )

inlineinherited

Gets last error.

Return values

int	Error number of last write error

virtual String IDataSourceStream::id ( ) const

inlinevirtualinherited

Returns unique id of the resource.

Return values

String the unique id of the stream.

Reimplemented in FileStream, GdbFileStream, and CircularBuffer.

virtual bool IDataSourceStream::isFinished ( )

pure virtualinherited

Check if all data has been read.

Return values

bool	True on success.

Implemented in HardwareSerial, FileStream, StreamTransformer, MemoryDataStream, TemplateStream, rBootItemOutputStream, CircularBuffer, LimitedMemoryStream, UrlencodedOutputStream, GdbFileStream, EndlessMemoryStream, FlashMemoryStream, MultiStream, and ArduCAMStream.

virtual bool IDataSourceStream::isValid ( ) const

inlinevirtualinherited

Determine if the stream object contains valid data.

Return values

bool	true if valid, false if invalid

Note: Where inherited classes are initialised by constructor this method indicates whether that was successful or not (e.g. FileStream)

Reimplemented in FileStream, and GdbFileStream.

int IDataSourceStream::length ( )

inlineinherited

Return the total length of the stream.

Return values

int	-1 is returned when the size cannot be determined

Deprecated:: Use available() instead

int IDataSourceStream::peek ( )

overridevirtualinherited

Read a character without advancing the stream pointer.

Return values

int	The character that was read or -1 if none is available

Implements Stream.

Reimplemented in HardwareSerial.

size_t Print::print ( char )

inherited

Prints a single character to output stream.

Return values

size_t Quantity of characters written to stream

size_t Print::print ( const char [] )

inherited

Prints a c-string to output stream.

Parameters

char[] c-string to print

Return values

size_t	Quantity of characters written to output stream
size_t	Quantity of characters written to stream

size_t Print::print	(	unsigned	char,
		int	base = `DEC`
	)

inherited

Prints a number to output stream.

Parameters

unsigned long	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

Parameters

unsigned int	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

Parameters

unsigned char	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

size_t Print::print	(	long	,
		int	base = `DEC`
	)

inherited

Prints a number to output stream.

Parameters

long	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

size_t Print::print	(	int	,
		int	base = `DEC`
	)

inherited

Prints a number to output stream.

Parameters

int	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

size_t Print::print	(	double	,
		int	digits = `2`
	)

inherited

Prints number to output stream.

Prints a number to output stream.

Parameters

double	Number to print
int	Decimal places to show

Return values

size_t Quantity of characters written to output stream

Parameters

double	Number to print
digits	The decimal places to print (Default: 2, e.g. 21.35)

Return values

size_t Quantity of characters written to stream

size_t Print::print ( const Printable & p )

inherited

Prints a Printable object to output stream.

Parameters

p	Object to print

Return values

size_t Quantity of characters written to stream

size_t Print::print ( const String & s )

inherited

Prints a String to output stream.

Parameters

s	String to print

Return values

size_t Quantity of characters written to stream

size_t Print::printf	(	const char *	fmt,
			...
	)

inherited

Prints a formatted c-string to output stream.

Parameters

fmt	Pointer to formated c-string to print
...	Parameters for placeholders within formated string

Return values

size_t Quantity of characters written to stream

Note: Use standard printf placeholders, e.g. d for integer, s for c-string, etc.

size_t Print::println ( void )

inherited

Prints a newline to output stream.

Parameters

Prints newline to output stream

Return values

size_t	Quantity of characters written to output stream
size_t	Quantity of characters written to stream

size_t Print::println ( const char [] )

inherited

Prints a c-string to output stream, appending newline.

Parameters

char[] c-string to print

Return values

size_t Quantity of characters written to stream

size_t Print::println ( char )

inherited

Prints a single character to output stream, appending newline.

Parameters

char	Character to print

Return values

size_t Quantity of characters written to stream

size_t Print::println	(	unsigned	long,
		int	base = `DEC`
	)

inherited

Prints a number to output stream, appending newline.

Parameters

unsigned char	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

Parameters

unsigned int	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

Parameters

unsigned long	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

size_t Print::println	(	int	,
		int	base = `DEC`
	)

inherited

Prints a number to output stream, appending newline.

Parameters

int	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

size_t Print::println	(	long	,
		int	base = `DEC`
	)

inherited

Prints a number to output stream, appending newline.

Parameters

long	Number to print
base	The base for output (Default: Decimal (base 10))

Return values

size_t Quantity of characters written to stream

size_t Print::println	(	double	,
		int	digits = `2`
	)

inherited

Prints a number to output stream, appending newline.

Parameters

double	Number to print
digits	The decimal places to print (Default: 2, e.g. 21.35)

Return values

size_t Quantity of characters written to stream

size_t Print::println ( const Printable & p )

inherited

Prints a Printable object to output stream, appending newline.

Parameters

p	Object to print

Return values

size_t Quantity of characters written to stream

size_t Print::println ( const String & s )

inherited

Prints a String to output stream, appending newline.

Parameters

s	String to print

Return values

size_t Quantity of characters written to stream

int IDataSourceStream::read ( )

overridevirtualinherited

Read one character and moves the stream pointer.

Return values

The	character that was read or -1 if none is available

Implements Stream.

Reimplemented in HardwareSerial.

virtual uint16_t IDataSourceStream::readMemoryBlock	(	char *	data,
		int	bufSize
	)

pure virtualinherited

Read a block of memory.

Parameters

data	Pointer to the data to be read
bufSize	Quantity of chars to read

Return values

uint16_t Quantity of chars read

Todo:: Should IDataSourceStream::readMemoryBlock return same data type as its bufSize param?

Implemented in HardwareSerial, FileStream, StreamTransformer, MemoryDataStream, TemplateStream, rBootItemOutputStream, CircularBuffer, GdbFileStream, LimitedMemoryStream, UrlencodedOutputStream, FlashMemoryStream, JsonObjectStream, MultiStream, EndlessMemoryStream, and ArduCAMStream.

virtual bool IDataSourceStream::seek ( int len )

pure virtualinherited

Move read cursor.

Parameters

len	Relative cursor adjustment

Return values

bool	True on success.

Implemented in HardwareSerial, FileStream, StreamTransformer, MemoryDataStream, TemplateStream, rBootItemOutputStream, CircularBuffer, GdbFileStream, UrlencodedOutputStream, LimitedMemoryStream, FlashMemoryStream, EndlessMemoryStream, MultiStream, and ArduCAMStream.

size_t ReadWriteStream::write ( uint8_t charToWrite )

inlineoverridevirtual

Write a single character to the stream.

Parameters

charToWrite

Return values

size_t Number of chars written (1 on success, 0 on failure)

Reimplemented from IDataSourceStream.

virtual size_t ReadWriteStream::write	(	const uint8_t *	buffer,
		size_t	size
	)

pure virtual

Write chars to stream.

Parameters

buffer	Pointer to buffer to write to the stream
size	Quantity of chars to write

Return values

size_t Quantity of chars written to stream

Note: Although this is defined in the Print class, ReadWriteStream uses this as the core output method so descendants are required to implement it

Reimplemented from Print.

Implemented in HardwareSerial, CircularBuffer, FileStream, MemoryDataStream, LimitedMemoryStream, EndlessMemoryStream, GdbFileStream, and rBootItemOutputStream.

size_t Print::write ( const char * str )

inlineinherited

Writes a c-string to output stream.

Parameters

str	Pointer to c-string

Return values

size_t Quantity of characters written to stream

size_t Print::write	(	const char *	buffer,
		size_t	size
	)

inlineinherited

Writes characters from a buffer to output stream.

Parameters

buffer	Pointer to character buffer
size	Quantity of characters to write

Return values

size_t Quantity of characters written to stream

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation