Stream Class Referenceabstract

Inherits Print.

Inherited by Client, HardwareSerial, TwoWire, and UDP.

Public Member Functions
virtual int	available ()=0
	available() gets the number of bytes available in the stream. This is only for bytes that have already arrived. More...
virtual int	read ()=0
	read() reads characters from an incoming stream to the buffer. More...
virtual int	peek ()=0
	Read a byte from the file without advancing to the next one. That is, successive calls to peek() will return the same value, as will the next call to read(). More...
void	setTimeout (unsigned long timeout)
	setTimeout() sets the maximum milliseconds to wait for stream data, it defaults to 1000 milliseconds. This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the Stream class main page for more information. More...
bool	find (const char *target)
	find() reads data from the stream until the target string of given length is found The function returns true if target string is found, false if timed out. More...
bool	find (uint8_t *target)
	find() reads data from the stream until the target string of given length is found The function returns true if target string is found, false if timed out. More...
bool	find (const char *target, size_t length)
	find() reads data from the stream until the target string of given length is found The function returns true if target string is found, false if timed out. More...
bool	find (const uint8_t *target, size_t length)
	find() reads data from the stream until the target string of given length is found The function returns true if target string is found, false if timed out. More...
bool	find (char target)
	find() reads data from the stream until the target string of given length is found The function returns true if target string is found, false if timed out. More...
bool	findUntil (const char *target, const char *terminator)
	findUntil() reads data from the stream until the target string of given length or terminator string is found. More...
bool	findUntil (const uint8_t *target, const char *terminator)
	findUntil() reads data from the stream until the target string of given length or terminator string is found. More...
bool	findUntil (const char *target, size_t targetLen, const char *terminate, size_t termLen)
	findUntil() reads data from the stream until the target string of given length or terminator string is found. More...
bool	findUntil (const uint8_t *target, size_t targetLen, const char *terminate, size_t termLen)
	findUntil() reads data from the stream until the target string of given length or terminator string is found. More...
long	parseInt ()
	parseInt() returns the first valid (long) integer number from the serial buffer. Characters that are not integers (or the minus sign) are skipped. More...
float	parseFloat ()
	parseFloat() returns the first valid floating point number from the current position. Initial characters that are not digits (or the minus sign) are skipped. parseFloat() is terminated by the first character that is not a floating point number. More...
virtual size_t	readBytes (char *buffer, size_t length)
	readBytes() read characters from a stream into a buffer. The function terminates if the determined length has been read, or it times out (see setTimeout()). More...
virtual size_t	readBytes (uint8_t *buffer, size_t length)
	readBytes() read characters from a stream into a buffer. The function terminates if the determined length has been read, or it times out (see setTimeout()). More...
size_t	readBytesUntil (char terminator, char *buffer, size_t length)
	readBytesUntil() reads characters from a stream into a buffer. The function terminates if the terminator character is detected, the determined length has been read, or it times out (see setTimeout()). More...
size_t	readBytesUntil (char terminator, uint8_t *buffer, size_t length)
	readBytesUntil() reads characters from a stream into a buffer. The function terminates if the terminator character is detected, the determined length has been read, or it times out (see setTimeout()). More...
String	readString ()
	readString() reads characters from a stream into a string. The function terminates if it times out (see setTimeout()). More...
String	readStringUntil (char terminator)
	readStringUntil() reads characters from a stream into a string. The function terminates if the terminator character is detected or it times out (see setTimeout()). More...
Public Member Functions inherited from Print
int	getWriteError ()
	This function is used to get write error number. More...
void	clearWriteError ()
	This function is used to clear write error number. More...
virtual size_t	write (uint8_t)=0
	This pure virtual function is used to define the operation that writes binary data. More...
virtual size_t	write (const uint8_t *buffer, size_t size)
	This function is used to write buffer to the interface defined by the object. More...
size_t	write (const char *str)
	This function is used to write buffer to the interface defined by the object. More...
size_t	write (const char *buffer, size_t size)
	This function is used to write buffer to the interface defined by the object. More...
size_t	print (const String &)
	This function is used to print buffer to the interface defined by the object. More...
size_t	print (const char [])
	This function is used to print buffer to the interface defined by the object. More...
size_t	print (char)
	This function is used to print buffer to the interface defined by the object. More...
size_t	print (unsigned char, int=DEC)
	This function is used to print target to the interface defined by the object. More...
size_t	print (int, int=DEC)
	This function is used to print target to the interface defined by the object. More...
size_t	print (unsigned int, int=DEC)
	This function is used to print target to the interface defined by the object. More...
size_t	print (long, int=DEC)
	This function is used to print target to the interface defined by the object. More...
size_t	print (unsigned long, int=DEC)
	This function is used to print target to the interface defined by the object. More...
size_t	print (double, int=BIN)
	This function is used to print target to the interface defined by the object. More...
size_t	print (const Printable &)
	This function is used to print target to the interface defined by the object. More...
size_t	println (void)
	This function is used to print target to the interface defined by the object with carriage ret ('') and new line (' '). More...
size_t	println (const String &s)
	This function is used to print target to the interface defined by the object with carriage ret ('') and new line (' '). More...
size_t	println (const char [])
	This function is used to print target to the interface defined by the object with carriage ret ('') and new line (' '). More...
size_t	println (char)
	This function is used to print target to the interface defined by the object with carriage ret ('') and new line (' '). More...
size_t	println (unsigned char, int=DEC)
	This function is used to print target to the interface defined by the object with carriage ret ('') and new line (' '). More...
size_t	println (int, int=DEC)
	This function is used to print target to the interface defined by the object with carriage ret ('') and new line (' '). More...
size_t	println (unsigned int, int=DEC)
	This function is used to print target to the interface defined by the object with carriage ret ('') and new line (' '). More...
size_t	println (long, int=DEC)
	This function is used to print target to the interface defined by the object with carriage ret ('') and new line (' '). More...
size_t	println (unsigned long, int=DEC)
	This function is used to print target to the interface defined by the object with carriage ret ('') and new line (' '). More...
size_t	println (double, int=BIN)
	This function is used to print target to the interface defined by the object with carriage ret ('') and new line (' '). More...
size_t	println (const Printable &)
	This function is used to print target to the interface defined by the object with carriage ret ('') and new line (' '). More...

Protected Member Functions
int	timedRead ()
int	timedPeek ()
int	peekNextDigit ()
long	parseInt (char skipChar)
float	parseFloat (char skipChar)
Protected Member Functions inherited from Print
void	setWriteError (int err=1)

Protected Attributes
unsigned long	_timeout
unsigned long	_startMillis