File Transfer Protocol server channel class

Inheritance:

Public Methods

	PFTPServer () declare a server socket
	~PFTPServer () Delete the server, cleaning up passive sockets
virtual PString	GetHelloString (const PString & user) const Get the string printed when a user logs in default value is a string giving the user name
virtual PString	GetGoodbyeString (const PString & user) const return the string printed just before exiting
virtual PString	GetSystemTypeString () const return the string to be returned by the SYST command
BOOL	GetAllowThirdPartyPort () const return the thirdPartyPort flag, allowing 3 host put and get
void	SetAllowThirdPartyPort (BOOL state) Set the thirdPartyPort flag
BOOL	ProcessCommand () Process commands, dispatching to the appropriate virtual function.
virtual BOOL	DispatchCommand ( PINDEX code, const PString & args ) Dispatching to the appropriate virtual function.
virtual BOOL	CheckLoginRequired ( PINDEX cmd ) Check to see if the command requires the server to be logged in before it may be processed.
virtual BOOL	AuthoriseUser ( const PString & user, const PString & password, BOOL & replied ) Validate the user name and password for access.
virtual BOOL	OnUnknown ( const PCaselessString & command ) Handle an unknown command.
virtual void	OnError ( PINDEX errorCode, PINDEX cmdNum, const char* msg ) Handle an error in command.
virtual void	OnSyntaxError ( PINDEX cmdNum ) Called for syntax errors in commands.
virtual void	OnNotImplemented ( PINDEX cmdNum ) Called for unimplemented commands.
virtual void	OnCommandSuccessful ( PINDEX cmdNum ) Called for successful commands.
void	SendToClient ( const PFilePath & filename ) Send the specified file to the client.

Protected Methods

BOOL	OnOpen () Call back to verify open succeeded in an PInternetProtocol class

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 server channel class

PFTPServer()

declare a server socket

~PFTPServer()

Delete the server, cleaning up passive sockets

virtual PString GetHelloString(const PString & user) const

Get the string printed when a user logs in default value is a string giving the user name

virtual PString GetGoodbyeString(const PString & user) const

return the string printed just before exiting

virtual PString GetSystemTypeString() const

return the string to be returned by the SYST command

BOOL GetAllowThirdPartyPort() const

return the thirdPartyPort flag, allowing 3 host put and get

void SetAllowThirdPartyPort(BOOL state)

Set the thirdPartyPort flag

BOOL ProcessCommand()

Process commands, dispatching to the appropriate virtual function. This is used when the socket is acting as a server.

Returns:

TRUE if more processing may be done, FALSE if the QUIT command was received or the OnUnknown() function returns FALSE.

virtual BOOL DispatchCommand( PINDEX code, const PString & args )

Dispatching to the appropriate virtual function. This is used when the socket is acting as a server.

Parameters:

code - Parsed command code.
- args Arguments to command.

Returns:

TRUE if more processing may be done, FALSE if the QUIT command was received or the OnUnknown() function returns FALSE.

virtual BOOL CheckLoginRequired( PINDEX cmd )

Check to see if the command requires the server to be logged in before it may be processed.

Parameters:

cmd - Command to check if log in required.

Returns:

TRUE if the command required the user to be logged in.

virtual BOOL AuthoriseUser( const PString & user, const PString & password, BOOL & replied )

Validate the user name and password for access. After three invalid attempts, the socket will close and FALSE is returned.

Default implementation returns TRUE for all strings.

Parameters:

user - User name to authorise.
password - Password supplied for the user.
replied - Indication that a reply was sent to client.

Returns:

TRUE if user can access, otherwise FALSE

virtual BOOL OnUnknown( const PCaselessString & command )

Handle an unknown command.

Parameters:

command - Complete command line received.

Returns:

TRUE if more processing may be done, FALSE if the ProcessCommand() function is to return FALSE.

virtual void OnError( PINDEX errorCode, PINDEX cmdNum, const char* msg )

Handle an error in command.

Parameters:

errorCode - Error code to use
cmdNum - Command that had the error.
msg - Error message.

Returns:

TRUE if more processing may be done, FALSE if the ProcessCommand() function is to return FALSE.

virtual void OnSyntaxError( PINDEX cmdNum )

Called for syntax errors in commands.

Parameters:

cmdNum - Command that had the syntax error.

virtual void OnNotImplemented( PINDEX cmdNum )

Called for unimplemented commands.

Parameters:

cmdNum - Command that was not implemented.

virtual void OnCommandSuccessful( PINDEX cmdNum )

Called for successful commands.

Parameters:

cmdNum - Command that had was successful.

void SendToClient( const PFilePath & filename )

Send the specified file to the client.

Parameters:

filename - File name to send.

BOOL OnOpen()

Call back to verify open succeeded in an PInternetProtocol class

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java