Ftp::Channel Class Reference

#include <FtpClient.h>

Inheritance diagram for Ftp::Channel:

Collaboration diagram for Ftp::Channel:

Public Member Functions
void	opened (const Comm::ConnectionPointer &conn, const AsyncCall::Pointer &aCloser)
	called after the socket is opened, sets up close handler More...
void	close ()
	planned close: removes the close handler and calls comm_close More...
void	forget ()
void	clear ()
	remove the close handler, leave connection open More...

Public Attributes
Comm::ConnectionPointer	conn
	channel descriptor More...
Comm::ConnectionPointer	listenConn

Private Attributes
AsyncCall::Pointer	closer
	Comm close handler callback. More...

Detailed Description

Common code for FTP server control and data channels. Does not own the channel descriptor, which is managed by Ftp::Client.

Definition at line 43 of file FtpClient.h.

Member Function Documentation

clear()

void Ftp::Channel::clear

(

)

just drops conn and close handler. does not close active connections.

Definition at line 128 of file FtpClient.cc.

References conn.

Referenced by ftpOpenListenSocket().

close()

void Ftp::Channel::close

(

)

Handles all operations needed to properly close the active channel FD. clearing the close handler, clearing the listen socket properly, and calling comm_close

Definition at line 107 of file FtpClient.cc.

References comm_remove_close_handler(), conn, and Comm::IsConnOpen().

Referenced by ftpOpenListenSocket().

forget()

void Ftp::Channel::forget

(

)

Definition at line 118 of file FtpClient.cc.

References comm_remove_close_handler(), commUnsetConnTimeout(), conn, and Comm::IsConnOpen().

opened()

void Ftp::Channel::opened	(	const Comm::ConnectionPointer &	conn,
		const AsyncCall::Pointer &	aCloser
	)

configures the channel with a descriptor and registers a close handler

Definition at line 90 of file FtpClient.cc.

References assert, comm_add_close_handler(), conn, and Comm::IsConnOpen().

Referenced by Ftp::Client::Client().

Member Data Documentation

closer

AsyncCall::Pointer Ftp::Channel::closer

private

Definition at line 68 of file FtpClient.h.

conn

Comm::ConnectionPointer Ftp::Channel::conn

Definition at line 58 of file FtpClient.h.

Referenced by ftpOpenListenSocket(), ftpReadList(), ftpReadRetr(), and Ftp::Relay::HandleStoreAbort().

listenConn

Comm::ConnectionPointer Ftp::Channel::listenConn

A temporary handle to the connection being listened on. Closing this will also close the waiting Data channel acceptor. If a data connection has already been accepted but is still waiting in the event queue the callback will still happen and needs to be handled (usually dropped).

Definition at line 65 of file FtpClient.h.

Referenced by ftpSendPORT().

---

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

• src/clients/FtpClient.h
• src/clients/FtpClient.cc