Collapse all Symbian^3 Product Developer Library

MFtpSessionNotifier Class Reference

class MFtpSessionNotifier

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.

Public Member Functions
void	Cancel(void)
void	Complete(void)
void	ConnReset(void)
void	ConnectionError(TOpComp)
void	EUnknownError()
void	LocalFileSystemError(TOpComp)
void	MoreData(void)
void	OperationNotSupported(void)
void	RemoteFileSystemError(TOpComp)
void	ServerMessage(const TDesC8 &)
void	TransferProgress(TUint)

Public Member Enumerations
enum	TOpComp { EOpComplete = 0, EOpCanceled, EHostNotExist, ESocketError, EConnectionFailed, EPasswordNeeded, EAccountNeeded, ELoginFailed, ENotConnected, EAlreadyConnected, ETimedOut, EFileSystemError, EFileOpenFailure, EFileReadError, EFileWriteError, EFileAlreadyExist, EFileNotExist, EDirAlreadyExist, EDirNotExist, EPermissionDenied, ERemoteFileSystemError, ERemoteFileOpenFailure, ERemoteFileReadError, ERemoteFileWriteError, ERemoteFileAlreadyExist, ERemoteFileNotExist, ERemoteDirAlreadyExist, ERemoteDirNotExist, ERestartNotSupported }

Public Member Enumerations

enum

TOpComp {
EOpComplete = 0, EOpCanceled, EHostNotExist, ESocketError, EConnectionFailed, EPasswordNeeded, EAccountNeeded, ELoginFailed, ENotConnected, EAlreadyConnected, ETimedOut, EFileSystemError, EFileOpenFailure, EFileReadError, EFileWriteError, EFileAlreadyExist, EFileNotExist, EDirAlreadyExist, EDirNotExist, EPermissionDenied, ERemoteFileSystemError, ERemoteFileOpenFailure, ERemoteFileReadError, ERemoteFileWriteError, ERemoteFileAlreadyExist, ERemoteFileNotExist, ERemoteDirAlreadyExist, ERemoteDirNotExist, ERestartNotSupported
}

Member Functions Documentation

Cancel(void)

void

Cancel

(

void

)

[pure virtual]

User cancelled an on-going operation.

Parameters

void

Complete(void)

void

Complete

(

void

)

[pure virtual]

Normal operation completion.

Parameters

void

ConnReset(void)

void

ConnReset

(

void

)

[pure virtual]

Peer reset the connection.

Parameters

void

ConnectionError(TOpComp)

void

ConnectionError

(

TOpComp

aTConnectionError

)

[pure virtual]

Error in establishing the connection with the FTP server.

Parameters

TOpComp aTConnectionError

Operation completion code

EUnknownError()

void

EUnknownError

(

)

[pure virtual]

Unspecified error.

LocalFileSystemError(TOpComp)

void

LocalFileSystemError

(

TOpComp

aTLocalFileSystemError

)

[pure virtual]

Error with the local file system.

Parameters

TOpComp aTLocalFileSystemError

Operation completion code

MoreData(void)

void

MoreData

(

void

)

[pure virtual]

Operation partially completed, with more data to follow.

Parameters

void

OperationNotSupported(void)

void

OperationNotSupported

(

void

)

[pure virtual]

Restart operation not supported.

Parameters

void

RemoteFileSystemError(TOpComp)

void

RemoteFileSystemError

(

TOpComp

aTRemoteFileSystemError

)

[pure virtual]

Error with the remote file system.

Parameters

TOpComp aTRemoteFileSystemError

Operation completion code

ServerMessage(const TDesC8 &)

void

ServerMessage

(

const TDesC8 &

)

[pure virtual]

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 digit 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

const TDesC8 &

TransferProgress(TUint)

void

TransferProgress

(

TUint

aProgress

)

[pure virtual]

Reports the amount of data already transferred in bytes.

Parameters

TUint aProgress

Amount of data already transferred

Member Enumerations Documentation

Enum TOpComp

FTP engine/session operation completeness codes.

Enumerators

EOpComplete = 0	Operation completed normally.
EOpCanceled	Operation cancelled.
EHostNotExist	Connection error: Connect address invalid.
ESocketError	Connection error: Sockets level error.
EConnectionFailed	Connection error: Connection failed.
EPasswordNeeded	Connection error: Password needed.
EAccountNeeded	Connection error: Anonymous login not permitted.
ELoginFailed	Connection error: UserName, Password combination invalid.
ENotConnected	Connection error: Not connected to a server.
EAlreadyConnected	Connection error: Already connected to a server.
ETimedOut	Connection error: Operation timed out.
EFileSystemError	Local filesystem error: General file system error.
EFileOpenFailure	Local filesystem error: File opening failure.
EFileReadError	Local filesystem error: File reading failure.
EFileWriteError	Local filesystem error: File writing failure.
EFileAlreadyExist	Local filesystem error: File already exists.
EFileNotExist	Local filesystem error: File does not exist.
EDirAlreadyExist	Local filesystem error: Directory already exists.
EDirNotExist	Local filesystem error: Directory does not exist.
EPermissionDenied	Permission error: Permission denied.
ERemoteFileSystemError	Remote filesystem error: General remote file system error.
ERemoteFileOpenFailure	Remote filesystem error: Remote file opening failure.
ERemoteFileReadError	Remote filesystem error: Remote file reading failure.
ERemoteFileWriteError	Remote filesystem error: Remote file writing failure.
ERemoteFileAlreadyExist	Remote filesystem error: Remote file already exists.
ERemoteFileNotExist	Remote filesystem error: Remote file does not exist.
ERemoteDirAlreadyExist	Remote filesystem error: Remote directory already exists.
ERemoteDirNotExist	Remote filesystem error: Remote directory does not exist.
ERestartNotSupported	Remote filesystem error: Restart is not supported.