FtpServerConnection Class Reference

#include <FtpServerConnection.h>

Inheritance diagram for FtpServerConnection:

Collaboration diagram for FtpServerConnection:

Classes
struct	User

Public Member Functions
	FtpServerConnection (CustomFtpServer &parentServer, tcp_pcb *clientTcp)
err_t	onReceive (pbuf *buf) override
err_t	onSent (uint16_t len) override
void	dataTransferFinished (TcpConnection *connection)
void	dataStreamDestroyed (TcpConnection *connection)
const User &	getUser () const
IFS::FileSystem *	getFileSystem ()
virtual void	response (int code, String text=nullptr, char sep=' ')
Public Member Functions inherited from TcpConnection
	TcpConnection (bool autoDestruct)
	TcpConnection (tcp_pcb *connection, bool autoDestruct)
virtual	~TcpConnection ()
virtual bool	connect (const String &server, int port, bool useSsl=false)
virtual bool	connect (IpAddress addr, uint16_t port, bool useSsl=false)
virtual void	close ()
void	setAutoSelfDestruct (bool state)
int	writeString (const char *data, uint8_t apiflags=TCP_WRITE_FLAG_COPY)
	Writes string data directly to the TCP buffer. More...
int	writeString (const String &data, uint8_t apiflags=TCP_WRITE_FLAG_COPY)
	Writes string data directly to the TCP buffer. More...
virtual int	write (const char *data, int len, uint8_t apiflags=TCP_WRITE_FLAG_COPY)
	Base write operation. More...
int	write (IDataSourceStream *stream)
	Writes stream data directly to the TCP buffer. More...
uint16_t	getAvailableWriteSize ()
void	flush ()
void	setTimeOut (uint16_t waitTimeOut)
IpAddress	getRemoteIp () const
uint16_t	getRemotePort () const
void	setDestroyedDelegate (TcpConnectionDestroyedDelegate destroyedDelegate)
	Sets a callback to be called when the object instance is destroyed. More...
void	setSslInitHandler (Ssl::Session::InitDelegate handler)
	Set the SSL session initialisation callback. More...
bool	setSslConnection (Ssl::Connection *connection)
Ssl::Session *	getSsl ()
	Get a pointer to the current SSL session object. More...
bool	enableSsl (const String &hostName=nullptr)
	Enables Secure Socket Layer on the current connection. More...
Public Member Functions inherited from IpConnection
bool	joinMulticastGroup (IpAddress localIp, IpAddress multicastIp)
	Uses IGMP to add a local network interface to multicast group. More...
bool	joinMulticastGroup (IpAddress multicastIp)
	Uses IGMP to add all local network interfaces to multicast group. More...
bool	leaveMulticastGroup (IpAddress localIp, IpAddress multicastIp)
	Uses IGMP to remove a local network interface from multicast group. More...
bool	leaveMulticastGroup (IpAddress multicastIp)
	Uses IGMP to remove all local network interfaces from multicast group. More...

Static Public Attributes
static constexpr size_t	MAX_FTP_CMD {255}

Protected Member Functions
virtual void	onCommand (String cmd, String data)
void	cmdPort (const String &data)
void	setDataConnection (FtpDataStream *connection)
String	resolvePath (const char *name)
bool	checkFileAccess (const char *filename, IFS::OpenFlags flags)
Protected Member Functions inherited from TcpConnection
void	initialize (tcp_pcb *pcb)
bool	internalConnect (IpAddress addr, uint16_t port)
bool	sslCreateSession ()
virtual void	sslInitSession (Ssl::Session &session)
	Override in inherited classes to perform custom session initialisation. More...
virtual err_t	onConnected (err_t err)
virtual err_t	onPoll ()
virtual void	onError (err_t err)
virtual void	onReadyToSendData (TcpConnectionEvent sourceEvent)
virtual void	onClosed ()
	Gets called when there is/was a tcp connection, the latter does not have to be established, that is closed due to error or normal disconnect. More...
void	trySend (TcpConnectionEvent event)
err_t	internalOnConnected (err_t err)
err_t	internalOnReceive (pbuf *p, err_t err)
err_t	internalOnSent (uint16_t len)
err_t	internalOnPoll ()
void	internalOnError (err_t err)
void	internalOnDnsResponse (const char *name, LWIP_IP_ADDR_T *ipaddr, int port)

Friends
class	FtpDataStream
class	CustomFtpServer

Additional Inherited Members
Protected Attributes inherited from TcpConnection
tcp_pcb *	tcp = nullptr
uint16_t	sleep = 0
uint16_t	timeOut = USHRT_MAX
	By default a TCP connection does not have a time out. More...
bool	canSend = true
bool	autoSelfDestruct = true
Ssl::Session *	ssl = nullptr
Ssl::Session::InitDelegate	sslInit
bool	useSsl = false

Constructor & Destructor Documentation

FtpServerConnection()

FtpServerConnection::FtpServerConnection	(	CustomFtpServer &	parentServer,
		tcp_pcb *	clientTcp
	)

Member Function Documentation

checkFileAccess()

bool FtpServerConnection::checkFileAccess ( const char *  filename, IFS::OpenFlags  flags  )

protected

cmdPort()

void FtpServerConnection::cmdPort ( const String &  data )

protected

dataStreamDestroyed()

void FtpServerConnection::dataStreamDestroyed

(

TcpConnection *

connection

)

dataTransferFinished()

void FtpServerConnection::dataTransferFinished

(

TcpConnection *

connection

)

getFileSystem()

IFS::FileSystem* FtpServerConnection::getFileSystem

(

)

getUser()

const User& FtpServerConnection::getUser ( ) const

inline

onCommand()

virtual void FtpServerConnection::onCommand ( String  cmd, String  data  )

protectedvirtual

onReceive()

err_t FtpServerConnection::onReceive ( pbuf *  buf )

overridevirtual

Reimplemented from TcpConnection.

onSent()

err_t FtpServerConnection::onSent ( uint16_t  len )

overridevirtual

Reimplemented from TcpConnection.

resolvePath()

String FtpServerConnection::resolvePath ( const char *  name )

protected

response()

virtual void FtpServerConnection::response ( int  code, String  text = nullptr, char  sep = ' '  )

virtual

setDataConnection()

void FtpServerConnection::setDataConnection ( FtpDataStream *  connection )

protected

Friends And Related Function Documentation

CustomFtpServer

friend class CustomFtpServer

friend

FtpDataStream

friend class FtpDataStream

friend

Member Data Documentation

MAX_FTP_CMD

constexpr size_t FtpServerConnection::MAX_FTP_CMD {255}

staticconstexpr

---

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

• FtpServerConnection.h