Class MFtpSessionNotifier

class MFtpSessionNotifier;

Description

FTP session callback interface.

An FTP session client implements this interface to receive status and results from asynchronous FTP operations.

Note that, as defined in RFC959, FTP does not allow concurrent execution of several requests, hence even though calling an FTP function and getting the result through this interface are asynchronous operations, these events happen in a sequential manner. Each notification that the client receives corresponds to only one currently outstanding operation.

Defined in MFtpSessionNotifier:
Cancel(), Complete(), ConnReset(), ConnectionError(), EAccountNeeded, EAlreadyConnected, EConnectionFailed, EDirAlreadyExist, EDirNotExist, EFileAlreadyExist, EFileNotExist, EFileOpenFailure, EFileReadError, EFileSystemError, EFileWriteError, EHostNotExist, ELoginFailed, ENotConnected, EOpCanceled, EOpComplete, EPasswordNeeded, EPermissionDenied, ERemoteDirAlreadyExist, ERemoteDirNotExist, ERemoteFileAlreadyExist, ERemoteFileNotExist, ERemoteFileOpenFailure, ERemoteFileReadError, ERemoteFileSystemError, ERemoteFileWriteError, ERestartNotSupported, ESocketError, ETimedOut, EUnknownError(), LocalFileSystemError(), MoreData(), OperationNotSupported(), RemoteFileSystemError(), ServerMessage(), TOpComp, TransferProgress()

virtual void Complete()=0;

Description

Normal operation completion.

virtual void MoreData()=0;

Description

Operation partially completed, with more data to follow.

virtual void TransferProgress(TUint aProgress)=0;

Description

Reports the amount of data already transferred in bytes.

Parameters

virtual void Cancel(void)=0;

Description

User cancelled an on-going operation.

virtual void ConnReset(void)=0;

Description

Peer reset the connection.

virtual void ConnectionError(TOpComp aTConnectionError)=0;

Description

Error in establishing the connection with the FTP server.

Parameters

virtual void OperationNotSupported(void)=0;

Description

Restart operation not supported.

virtual void LocalFileSystemError(TOpComp aTLocalFileSystemError)=0;

Description

Error with the local file system.

Parameters

virtual void RemoteFileSystemError(TOpComp aTRemoteFileSystemError)=0;

Description

Error with the remote file system.

Parameters

virtual void EUnknownError()=0;

Description

Unspecified error.

virtual void ServerMessage(const TDesC8&)=0;

Description

Message sent by the FTP server.

As specified by the RFC, the server answers all requests from the client with a plain text message beginning with a 3 digits code. The error/completion notifications sent back by the FTP session API are derived from these codes. Additionally, this function can be used to get the full string reporting the result of the request. It is recommended that the user interface displays this string to the user, as this gives a more precise idea of the result of the requested operation, especially in case of error.

Parameters

TOpComp

Description

FTP session operation completeness codes.