org.elastos.carrier.filetransfer

Class FileTransfer

java.lang.Object

org.elastos.carrier.filetransfer.FileTransfer

public class FileTransfer
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
void	acceptConnect() Accept file transfer connection request.
void	addFile(FileTransferInfo fileinfo) Add a file to queue of file transfer.
void	cancelTransfer(java.lang.String fileId, int status, java.lang.String reason) Cancel transferring file with specified fileId(only available to receiver).
void	close() Close file transfer instance.
void	connect() Send a file transfer connect request to target peer.
static java.lang.String	generateFileId() Generate unique file identifier with random algorithm.
java.lang.String	getFileId(java.lang.String filename) Get an unique file identifier of specified file.
java.lang.String	getFileName(java.lang.String fileId) Get file name by file id.
java.io.OutputStream	getOutputStream(java.lang.String fileId)
void	pendTransfer(java.lang.String fileId) Pend transferring file with specified fileId.
void	pullData(java.lang.String fileId, long offset) To send pull request to transfer file with specified fileId.
void	resumeTransfer(java.lang.String fileId) Resume transferring file with specified fileId.
void	sendFinish(java.lang.String fileId) Finish transferring file with specified fileId(only available to sender).
int	writeData(java.lang.String fileId, byte data) To transfer file data with specified fileId.
int	writeData(java.lang.String fileId, byte[] data) To transfer file data with specified fileId.
int	writeData(java.lang.String fileId, byte[] data, int offset, int len) To transfer file data with specified fileId.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

generateFileId

public static java.lang.String generateFileId()
                                       throws CarrierException

Generate unique file identifier with random algorithm. Application can call this function to explicitly generate transfer file id, or let file transfer module generate file id implicitly.

Returns:

The generated unique file identifier.

Throws:

CarrierException

close

public void close()

Close file transfer instance.

getFileId

public java.lang.String getFileId(java.lang.String filename)
                           throws CarrierException

Get an unique file identifier of specified file. Each file has its unique file id used between two peers.

Parameters:

filename - [in] The target file name.

Returns:

File id is returned if file transfer instance has file info of filename.

Throws:

CarrierException

getFileName

public java.lang.String getFileName(java.lang.String fileId)
                             throws CarrierException

Get file name by file id. Each file has its unique file id used between two peers.

Parameters:

fileId - [in] The target file identifier.

Returns:

File name is returned if file transfer instance has file id specified.

Throws:

CarrierException

connect

public void connect()
             throws CarrierException

Send a file transfer connect request to target peer.

Throws:

CarrierException

acceptConnect

public void acceptConnect()
                   throws CarrierException

Accept file transfer connection request.

Throws:

CarrierException

addFile

public void addFile(FileTransferInfo fileinfo)
             throws CarrierException

Add a file to queue of file transfer.

Parameters:

fileinfo - [in] Information of the file to be added.

Throws:

CarrierException

pullData

public void pullData(java.lang.String fileId,
                     long offset)
              throws CarrierException

To send pull request to transfer file with specified fileId.

Parameters:

fileId - [in] The file identifier.

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

Throws:

CarrierException

writeData

public int writeData(java.lang.String fileId,
                     byte[] data,
                     int offset,
                     int len)
              throws CarrierException

To transfer file data with specified fileId.

Parameters:

fileId - [in] The file identifier.

data - [in] The data to transfer for file.

offset - [in] The start offset.

len - [in] The bytes to write.

Returns:

Bytes of data sent on success.

Throws:

CarrierException

writeData

public int writeData(java.lang.String fileId,
                     byte[] data)
              throws CarrierException

To transfer file data with specified fileId.

Parameters:

fileId - [in] The file identifier.

data - [in] The data to transfer for file.

Returns:

Bytes of data sent on success.

Throws:

CarrierException

writeData

public int writeData(java.lang.String fileId,
                     byte data)
              throws CarrierException

To transfer file data with specified fileId.

Parameters:

fileId - [in] The file identifier.

data - [in] The data to transfer for file.

Returns:

Bytes of data sent on success.

Throws:

CarrierException

getOutputStream

public java.io.OutputStream getOutputStream(java.lang.String fileId)

sendFinish

public void sendFinish(java.lang.String fileId)
                throws CarrierException

Finish transferring file with specified fileId(only available to sender).

Parameters:

fileId - [in] The file identifier.

Throws:

CarrierException

cancelTransfer

public void cancelTransfer(java.lang.String fileId,
                           int status,
                           java.lang.String reason)
                    throws CarrierException

Cancel transferring file with specified fileId(only available to receiver).

Parameters:

fileId - [in] The file identifier.

status - [in] Cancel transfer status code.

reason - [in] Cancel transfer reason.

Throws:

CarrierException

pendTransfer

public void pendTransfer(java.lang.String fileId)
                  throws CarrierException

Pend transferring file with specified fileId.

Parameters:

fileId - [in] The file identifier.

Throws:

CarrierException

resumeTransfer

public void resumeTransfer(java.lang.String fileId)
                    throws CarrierException

Resume transferring file with specified fileId.

Parameters:

fileId - [in] The file identifier.

Throws:

CarrierException