class PFTPClient

File Transfer Protocol client channel class

Inheritance:

Public Methods
Protected Fields
Protected Methods

Inherited from PFTP:

Public Methods
BOOL SendPORT( const PIPSocket::Address & addr, WORD port )

Public Members
enum Commands
enum RepresentationType
enum DataChannelType
enum NameTypes

Inherited from PInternetProtocol:

Public Methods
virtual BOOL Read( void* buf, PINDEX len )
virtual BOOL Write( const void* buf, PINDEX len )
void SetReadLineTimeout( const PTimeInterval & t )
virtual BOOL Connect( const PString & address, WORD port = 0 )
virtual BOOL Accept( PSocket & listener )
const PString& GetDefaultService() const
PIPSocket* GetSocket() const
virtual BOOL WriteLine( const PString & line )
virtual BOOL ReadLine( PString & line, BOOL allowContinuation = FALSE )
virtual void UnRead( int ch )
virtual BOOL WriteCommand( PINDEX cmdNumber )
virtual BOOL ReadCommand( PINDEX & num, PString & args )
virtual BOOL WriteResponse( unsigned numericCode, const PString & info )
virtual BOOL ReadResponse()
virtual int ExecuteCommand( PINDEX cmdNumber )
int GetLastResponseCode() const
PString GetLastResponseInfo() const

Protected Methods
virtual PINDEX ParseResponse( const PString & line )

Inherited from PIndirectChannel:

Public Methods
Construction
Overrides from class PObject
Overrides from class PChannel
Channel establish functions

Protected Fields
PChannel* readChannel
BOOL readAutoDelete
PChannel* writeChannel
BOOL writeAutoDelete
PReadWriteMutex channelPointerMutex

Inherited from PChannel:

Public Methods
Information functions
Reading functions
Writing functions
Miscellaneous functions
static BOOL ConvertOSError( int libcReturnValue, Errors & lastError, int & osError )

Public Members
Error functions

Protected Fields
int os_handle
Errors lastErrorCode[NumErrorGroups+1]
int lastErrorNumber[NumErrorGroups+1]
PINDEX lastReadCount
PINDEX lastWriteCount
PTimeInterval readTimeout
PTimeInterval writeTimeout

Protected Methods
virtual BOOL ConvertOSError( int libcReturnValue, ErrorGroup group = LastGeneralError )
BOOL SetErrorValues( Errors errorCode, int osError, ErrorGroup group = LastGeneralError )
int ReadCharWithTimeout( PTimeInterval & timeout )

Inherited from PObject:

Public Methods
Run Time Type functions
I/O functions

Public Members
Comparison functions

Documentation

File Transfer Protocol client channel class

PFTPClient()

Declare an FTP client socket

~PFTPClient()

Delete and close the socket

Overrides from class PSocket.

virtual BOOL Close()
Close the socket, and if connected as a client, QUITs from server.

Returns:
TRUE if the channel was closed and the QUIT accepted by the server.

New functions for class

BOOL LogIn( const PString & username, const PString & password )
Log in to the remote host for FTP.

Parameters:
username - User name for FTP log in.
password - Password for the specified user name.
Returns:
TRUE if the log in was successfull.

PString GetSystemType()
Get the type of the remote FTP server system, eg Unix, WindowsNT etc.

Returns:
String for the type of system.

BOOL SetType( RepresentationType type )
Set the transfer type.

Parameters:
- type RepresentationTypeof file to transfer
Returns:
TRUE if transfer type set.

BOOL ChangeDirectory( const PString & dirPath )
Change the current directory on the remote FTP host.

Parameters:
dirPath - New directory
Returns:
TRUE if the log in was successfull.

PString GetCurrentDirectory()
Get the current working directory on the remote FTP host.

Returns:
String for the directory path, or empty string if an error occurred.

PStringArray GetDirectoryNames( NameTypes type = ShortNames, DataChannelType channel = Passive )
Get a list of files from the current working directory on the remote FTP host.

Parameters:
- type Detail level on a directory entry.
channel - Data channel type.
Returns:
String array for the files in the directory.

PStringArray GetDirectoryNames( const PString & path, NameTypes type = ShortNames, DataChannelType channel = Passive )
Get a list of files from the current working directory on the remote FTP host.

Parameters:
- path Name to get details for.
- type Detail level on a directory entry.
channel - Data channel type.
Returns:
String array for the files in the directory.

PString GetFileStatus( const PString & path, DataChannelType channel = Passive )
Get status information for the file path specified.

Parameters:
- path Path to get status for.
channel - Data channel type.
Returns:
String giving file status.

PTCPSocket* GetFile( const PString & filename, DataChannelType channel = NormalPort )
Begin retreiving a file from the remote FTP server. The second parameter indicates that the transfer is on a normal or passive data channel. In short, a normal transfer the server connects to the client and in passive mode the client connects to the server.

Parameters:
filename - Name of file to get
channel - Data channel type.
Returns:
Socket to read data from, or NULL if an error occurred.

PTCPSocket* PutFile( const PString & filename, DataChannelType channel = NormalPort )
Begin storing a file to the remote FTP server. The second parameter indicates that the transfer is on a normal or passive data channel. In short, a normal transfer the server connects to the client and in passive mode the client connects to the server.

Parameters:
filename - Name of file to get
channel - Data channel type.
Returns:
Socket to write data to, or NULL if an error occurred.

virtual BOOL OnOpen()

Call back to verify open succeeded in an PInternetProtocol class

WORD remotePort

Port number on remote system

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java

This page was generated with the help of DOC++.

	PFTPClient () Declare an FTP client socket
	~PFTPClient () Delete and close the socket
	Overrides from class PSocket.
	New functions for class