#include <Stream.h>

Inheritance diagram for Stream:

[legend]

Classes
struct	MultiTarget

Public Member Functions
virtual int	available ()=0

bool	find (char *target)

bool	find (uint8_t *target)

bool	find (char *target, size_t length)

bool	find (uint8_t *target, size_t length)

bool	find (char target)

bool	findUntil (char target, char terminator)

bool	findUntil (uint8_t target, char terminator)

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

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

unsigned long	getTimeout (void)

float	parseFloat (LookaheadMode lookahead=SKIP_ALL, char ignore=NO_IGNORE_CHAR)

long	parseInt (LookaheadMode lookahead=SKIP_ALL, char ignore=NO_IGNORE_CHAR)

virtual int	peek ()=0

virtual int	read ()=0

size_t	readBytes (char *buffer, size_t length)

size_t	readBytes (uint8_t *buffer, size_t length)

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

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

String	readString ()

String	readStringUntil (char terminator)

void	setTimeout (unsigned long timeout)

	Stream ()

Public Member Functions inherited from Print
virtual int	availableForWrite ()

void	clearWriteError ()

virtual void	flush ()

int	getWriteError ()

	Print ()

size_t	print (const __FlashStringHelper *)

size_t	print (const String &)

size_t	print (const char[])

size_t	print (char)

size_t	print (unsigned char, int=DEC)

size_t	print (int, int=DEC)

size_t	print (unsigned int, int=DEC)

size_t	print (long, int=DEC)

size_t	print (unsigned long, int=DEC)

size_t	print (double, int=2)

size_t	print (const Printable &)

size_t	println (const __FlashStringHelper *)

size_t	println (const String &s)

size_t	println (const char[])

size_t	println (char)

size_t	println (unsigned char, int=DEC)

size_t	println (int, int=DEC)

size_t	println (unsigned int, int=DEC)

size_t	println (long, int=DEC)

size_t	println (unsigned long, int=DEC)

size_t	println (double, int=2)

size_t	println (const Printable &)

size_t	println (void)

virtual size_t	write (uint8_t)=0

size_t	write (const char *str)

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

size_t	write (const char *buffer, size_t size)

Protected Member Functions
int	findMulti (struct MultiTarget *targets, int tCount)

float	parseFloat (char ignore)

long	parseInt (char ignore)

int	peekNextDigit (LookaheadMode lookahead, bool detectDecimal)

int	timedPeek ()

int	timedRead ()

Protected Member Functions inherited from Print
void	setWriteError (int err=1)

Protected Attributes
unsigned long	_startMillis

unsigned long	_timeout

Detailed Description

Definition at line 49 of file Stream.h.

Constructor & Destructor Documentation

Stream::Stream ( )

inline

Definition at line 63 of file Stream.h.

Member Function Documentation

virtual int Stream::available ( )

pure virtual

Implemented in HardwareSerial, UDP, TwoWire, and Client.

bool Stream::find ( char * target )

Definition at line 93 of file Stream.cpp.

bool Stream::find ( uint8_t * target )

inline

Definition at line 71 of file Stream.h.

bool Stream::find	(	char *	target,
		size_t	length
	)

Definition at line 100 of file Stream.cpp.

bool Stream::find	(	uint8_t *	target,
		size_t	length
	)

inline

Definition at line 75 of file Stream.h.

bool Stream::find ( char target )

inline

Definition at line 78 of file Stream.h.

int Stream::findMulti	(	struct MultiTarget *	targets,
		int	tCount
	)

protected

Definition at line 256 of file Stream.cpp.

bool Stream::findUntil	(	char *	target,
		char *	terminator
	)

Definition at line 106 of file Stream.cpp.

bool Stream::findUntil	(	uint8_t *	target,
		char *	terminator
	)

inline

Definition at line 81 of file Stream.h.

bool Stream::findUntil	(	char *	target,
		size_t	targetLen,
		char *	terminate,
		size_t	termLen
	)

Definition at line 114 of file Stream.cpp.

bool Stream::findUntil	(	uint8_t *	target,
		size_t	targetLen,
		char *	terminate,
		size_t	termLen
	)

inline

Definition at line 84 of file Stream.h.

unsigned long Stream::getTimeout ( void )

inline

Definition at line 68 of file Stream.h.

float Stream::parseFloat	(	LookaheadMode	lookahead = `SKIP_ALL`,
		char	ignore = `NO_IGNORE_CHAR`
	)

Definition at line 159 of file Stream.cpp.

float Stream::parseFloat ( char ignore )

inlineprotected

Definition at line 112 of file Stream.h.

long Stream::parseInt	(	LookaheadMode	lookahead = `SKIP_ALL`,
		char	ignore = `NO_IGNORE_CHAR`
	)

Definition at line 130 of file Stream.cpp.

long Stream::parseInt ( char ignore )

inlineprotected

Definition at line 111 of file Stream.h.

virtual int Stream::peek ( )

pure virtual

Implemented in HardwareSerial, UDP, TwoWire, and Client.

int Stream::peekNextDigit	(	LookaheadMode	lookahead,
		bool	detectDecimal
	)

protected

Definition at line 56 of file Stream.cpp.

virtual int Stream::read ( )

pure virtual

Implemented in HardwareSerial, UDP, TwoWire, and Client.

size_t Stream::readBytes	(	char *	buffer,
		size_t	length
	)

Definition at line 202 of file Stream.cpp.

size_t Stream::readBytes	(	uint8_t *	buffer,
		size_t	length
	)

inline

Definition at line 97 of file Stream.h.

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

Definition at line 219 of file Stream.cpp.

size_t Stream::readBytesUntil	(	char	terminator,
		uint8_t *	buffer,
		size_t	length
	)

inline

Definition at line 102 of file Stream.h.

String Stream::readString ( )

Definition at line 232 of file Stream.cpp.

String Stream::readStringUntil ( char terminator )

Definition at line 244 of file Stream.cpp.

void Stream::setTimeout ( unsigned long timeout )

Definition at line 87 of file Stream.cpp.

int Stream::timedPeek ( )

protected

Definition at line 43 of file Stream.cpp.

int Stream::timedRead ( )

protected

Definition at line 31 of file Stream.cpp.

Member Data Documentation

unsigned long Stream::_startMillis

protected

Definition at line 53 of file Stream.h.

unsigned long Stream::_timeout

protected

Definition at line 52 of file Stream.h.

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

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation