Arduino TinyFTP
All Classes Functions Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ftp_client::FTPSession< ClientType > Class Template Reference

FTPSession This class manages the FTP session, including command and data connections. It provides methods to initialize the session, open data connections, and manage the session lifecycle. More...

#include <FTPSession.h>

Public Member Functions

bool begin (IPAddress &address, int port, const char *username, const char *password)
 Initializes the session with the command client.
 
void end ()
 
FTPBasicAPIapi ()
 Returns the access to the basic API.
 
 operator bool ()
 Returns true if the command client is connected.
 
void setValid (bool valid)
 Used to set as invalid for dummy error session.
 

Protected Member Functions

void closeCommand ()
 
void closeData ()
 

Protected Attributes

ClientType command_client
 
ClientType data_client
 
FTPBasicAPI basic_api
 
bool is_valid = true
 

Detailed Description

template<class ClientType>
class ftp_client::FTPSession< ClientType >

FTPSession This class manages the FTP session, including command and data connections. It provides methods to initialize the session, open data connections, and manage the session lifecycle.

Note
The class is designed to be used in an Arduino environment, where the Client interface is typically implemented by network libraries such as WiFi or Ethernet.
Template Parameters
ClientTypeThe type of client to use for command and data connections. It should be a class that implements the Client interface.
Author
Phil Schatzmann

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