org.elastos.carrier.filetransfer

Interface FileTransferHandler

public interface FileTransferHandler

Method Summary

Modifier and Type	Method and Description
void	onCancel(FileTransfer filetransfer, java.lang.String fileId, int status, java.lang.String reason) An application-defined function that handles cancel file transfer notification from the peer.
boolean	onData(FileTransfer filetransfer, java.lang.String fileId, byte[] data) An application-defined function that perform receiving data.
void	onDataFinished(FileTransfer filetransfer, java.lang.String fileId) An application-defined function that handles the event of end of receiving data.
void	onFileRequest(FileTransfer filetransfer, java.lang.String fileId, java.lang.String filename, long size) An application-defined function that handle transfer file request event.
void	onPending(FileTransfer filetransfer, java.lang.String fileId) An application-defined function that handles pause file transfer notification from the peer.
void	onPullRequest(FileTransfer filetransfer, java.lang.String fileId, long offset) An application-defined function that handle file transfer pull request event.
void	onResume(FileTransfer filetransfer, java.lang.String fileId) An application-defined function that handles resume file transfer notification from the peer.
void	onStateChanged(FileTransfer filetransfer, FileTransferState state) An application-defined function that handle the state changed event.

Method Detail

onStateChanged

void onStateChanged(FileTransfer filetransfer,
                    FileTransferState state)

An application-defined function that handle the state changed event.

Parameters:

filetransfer - [in] Carrier file transfer instance.

state - [in] The file transfer connection state.

onFileRequest

void onFileRequest(FileTransfer filetransfer,
                   java.lang.String fileId,
                   java.lang.String filename,
                   long size)

An application-defined function that handle transfer file request event.

Parameters:

filetransfer - [in] Carrier file transfer instance.

fileId - [in] The file identifier.

filename - [in] The file name.

size - [in] The total file size.

onPullRequest

void onPullRequest(FileTransfer filetransfer,
                   java.lang.String fileId,
                   long offset)

An application-defined function that handle file transfer pull request event.

Parameters:

filetransfer - [in] Carrier file transfer instance.

fileId - [in] The file identifier.

offset - [in] The offset of file where transfer begins.

onData

boolean onData(FileTransfer filetransfer,
               java.lang.String fileId,
               byte[] data)

An application-defined function that perform receiving data.

Parameters:

filetransfer - [in] Carrier file transfer instance.

fileId - [in] The unique identifier of transferring file.

data - [in] The received data.

Returns:

Return false if you require no more data, otherwise return true.

onDataFinished

void onDataFinished(FileTransfer filetransfer,
                    java.lang.String fileId)

An application-defined function that handles the event of end of receiving data.

Parameters:

filetransfer - [in] Carrier file transfer instance.

fileId - [in] The unique identifier of transferring file.

onPending

void onPending(FileTransfer filetransfer,
               java.lang.String fileId)

An application-defined function that handles pause file transfer notification from the peer.

Parameters:

filetransfer - [in] Carrier file transfer instance.

fileId - [in] The unique identifier of transferring file.

onResume

void onResume(FileTransfer filetransfer,
              java.lang.String fileId)

An application-defined function that handles resume file transfer notification from the peer.

Parameters:

filetransfer - [in] Carrier file transfer instance.

fileId - [in] The unique identifier of transferring file.

onCancel

void onCancel(FileTransfer filetransfer,
              java.lang.String fileId,
              int status,
              java.lang.String reason)

An application-defined function that handles cancel file transfer notification from the peer.

Parameters:

filetransfer - [in] Carrier file transfer instance.

fileId - [in] The unique identifier of transferring file.

status - [in] Cancel transfer status code.

reason - [in] Cancel transfer reason.