FTPFile Class Reference

FTPFile A single file which supports read and write operations. This class is implemented as an Arduino Stream and therfore provides all corresponding functionality. More...

#include <TinyFTPClient.h>

Inheritance diagram for FTPFile:

Public Member Functions
	FTPFile (FTPBasicAPI *api_ptr, const char *name, FileMode mode)
	FTPFile (FTPFile &&move)
	FTPFile (FTPFile &cpy)
virtual int	available ()
virtual void	close ()
virtual void	flush ()
virtual bool	isDirectory ()
virtual const char *	name ()
virtual int	peek ()
virtual int	read ()
virtual int	read (void *buf, size_t nbyte)
virtual int	readln (void *buf, size_t nbyte)
virtual void	setEOL (char *eol)
virtual size_t	size ()
virtual size_t	write (char *data, int len)
virtual size_t	write (uint8_t data)
Public Member Functions inherited from arduino::Stream
bool	find (char target)
bool	find (const char *target)
bool	find (const char *target, size_t length)
bool	find (const uint8_t *target)
bool	find (const uint8_t *target, size_t length)
bool	findUntil (const char *target, const char *terminator)
bool	findUntil (const char *target, size_t targetLen, const char *terminate, size_t termLen)
bool	findUntil (const uint8_t *target, const char *terminator)
bool	findUntil (const uint8_t *target, size_t targetLen, const 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 size_t	readBytes (char *buffer, size_t length)
virtual 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)
Public Member Functions inherited from arduino::Print
virtual int	availableForWrite ()
void	clearWriteError ()
int	getWriteError ()
size_t	print (char)
size_t	print (const __FlashStringHelper *)
size_t	print (const char[])
size_t	print (const Printable &)
size_t	print (const String &)
size_t	print (double, int=2)
size_t	print (int, int=DEC)
size_t	print (long long, int=DEC)
size_t	print (long, int=DEC)
size_t	print (unsigned char, int=DEC)
size_t	print (unsigned int, int=DEC)
size_t	print (unsigned long long, int=DEC)
size_t	print (unsigned long, int=DEC)
size_t	println (char)
size_t	println (const __FlashStringHelper *)
size_t	println (const char[])
size_t	println (const Printable &)
size_t	println (const String &s)
size_t	println (double, int=2)
size_t	println (int, int=DEC)
size_t	println (long long, int=DEC)
size_t	println (long, int=DEC)
size_t	println (unsigned char, int=DEC)
size_t	println (unsigned int, int=DEC)
size_t	println (unsigned long long, int=DEC)
size_t	println (unsigned long, int=DEC)
size_t	println (void)
size_t	write (const char *buffer, size_t size)
size_t	write (const char *str)
virtual size_t	write (const uint8_t *buffer, size_t size)

Protected Attributes
FTPBasicAPI *	api_ptr
const char *	eol = "\n"
const char *	file_name
FileMode	mode
ObjectType	object_type = TypeUndefined
Protected Attributes inherited from arduino::Stream
unsigned long	_startMillis
unsigned long	_timeout

Additional Inherited Members
Protected Member Functions inherited from arduino::Stream
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 arduino::Print
void	setWriteError (int err=1)

Detailed Description

FTPFile A single file which supports read and write operations. This class is implemented as an Arduino Stream and therfore provides all corresponding functionality.

---

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

• ArduinoCore-Linux/libraries/TinyFTPClient/TinyFTPClient.h