Home | Trees | Index | Help |
---|
Package pyGlobus :: Module ftpClient :: Class FtpClient |
|
BaseFtpClient
--+
|
FtpClient
A class to wrap the ftp client functions.
It provides blocking and non-blocking transfers and access to the other ftp operations.Method Summary | |
---|---|
Constructs an instance. | |
Destroy an instance. | |
Delete a file from a ftp server. | |
Determines whether a file exists on a ftp server | |
Get a file from an ftp server with server-side processing.. | |
Store a file on an ftp server with server-side processing. | |
Transfer a file between two ftp servers with server-side processing. | |
Free a callback. | |
Get a file from an ftp server. | |
Get a file listing from an ftp server. | |
Make a directory on a ftp server. | |
Retrieves the size of a file on a ftp server | |
Move a file on a ftp server. | |
Get part of a file from a ftp server. | |
Put part of a file onto a ftp server. | |
Transfer part of a file between two ftp servers. | |
Store a file on an ftp server. | |
Register a data buffer to handle part of the ftp data transfer. | |
Register a data buffer to handle part of the ftp data transfer. | |
Remove a directory on a ftp server. | |
Retrieves the size of a file on a ftp server | |
Transfer a file between two ftp servers. | |
Get a file listing from an ftp server. | |
Inherited from BaseFtpClient | |
Abort the current operation. | |
Add a plugin to an FTP client handle. | |
Cache the connection to the FTP server. | |
Remove the url from the connection cache. | |
Return the underlying ftp client handle. | |
Returns the user data associated with the handle. | |
Remove a plugin to an FTP client handle. | |
Associate some data with the handle. |
Method Details |
---|
__init__(self,
handleAttr,
handle=None)
|
__del__(self)
|
delete(self, url, attr, callback, arg)Delete a file from a ftp server. The callback will be called with the final status of the delete.
|
exists(self, url, callback, arg, attr=None)Determines whether a file exists on a ftp server When the existence has been determined the complete callback is called
|
extended_get(self, url, eret_alg_str, callback, arg, attr=None, marker=None)Get a file from an ftp server with server-side processing.. After calling this method, register_read can be called to begin retrieving the data. When all of the data associated with this URL is retrieved, and all of the data callbacks have completed, or if the get request is aborted, the complete callback will be called with the final status of the get. This method differs from the get method by allowing the user to invoke server-side data processing algorithms. GridFTP servers may support support algorithms for data reduction or other customized data storage requirements. There is no client-side verification done on the algorithm string provided by the user. If the server does not understand the requested algorithm, the transfer will fail.
|
extended_put(self, url, esto_alg_str, callback, arg, attr=None, marker=None)Store a file on an ftp server with server-side processing. After calling this method, register_write can be called to begin writing the data. When all of the data associated with this URL is sent, and all of the data callbacks have completed, or if the put request is aborted, the complete callback will be called with the final status of the put. This method differs from the put method by allowing the user to invoke server-side data processing algorithms. GridFTP servers may support algorithms for data reduction or other customized data storage requirements. There is no client-side verification done on the alogirhtm string provided by the user. if the server does not understand * the requested algorithm, the transfer will fail.
|
extended_third_party_transfer(self, srcUrl, eret_alg_str, destUrl, esto_alg_str, callback, arg, srcAttr=None, destAttr=None, marker=None)Transfer a file between two ftp servers with server-side processing. When the transfer is complete, the complete callback will be called with the final status of the transfer. This method differs from the third_party_transfer method by allowing the user to invoke server-side data processing algorithms. GridFTP servers may support algorithms for data reduction or other customized data storage requirements. There is no client-side verification done on the alogirhtm string provided by the user. if the server does not understand the requested algorithm, the transfer will fail.
|
free_callback(self, cbHandle)Free a callback. Free's the underlying memory allocated for a callback structure.
|
get(self, url, callback, arg, attr=None, marker=None)Get a file from an ftp server. After calling this method, register_read can be called to begin retrieving the data. When all of the data associated with this URL is retrieved, and all of the data callbacks have completed, or if the get request is aborted, the complete callback will be called with the final status of the get.
|
list(self, url, attr, callback, arg)Get a file listing from an ftp server. This method starts a 'NLIST' transfer from an ftp server. The client may begin calling register_read to retrieve the listing, after this method returns. When all of the data associated with the listing is returned, and all of the data callbacks executed, the callback will be called with the final status of the list.
|
mkdir(self, url, attr, callback, arg)Make a directory on a ftp server. The callback will be called with the final status of the mkdir.
|
modification_time(self, url, callback, arg, attr=None)Retrieves the size of a file on a ftp server When the modification time is retrieved the complete callback is called
|
move(self, srcUrl, destUrl, attr, callback, arg)Move a file on a ftp server. The complete callback will be called when the move is completed.
|
partial_get(self, url, attr, marker, offset, endOffset, callback, arg)Get part of a file from a ftp server. After calling this method, register_read can be called to begin retrieving the data. When all of the data associated with this URL is retrieved, and all of the data callbacks have completed, or if the get request is aborted, the complete callback will be called with the final status of the get.
|
partial_put(self, url, attr, marker, offset, endOffset, callback, arg)Put part of a file onto a ftp server. After calling this method, register_write can be called to begin writing the data. When all of the data associated with this URL is sent, and all of the data callbacks have completed, or if the partial_put request is aborted, the complete callback will be called with the final status of the partial_put.
|
partial_third_party_transfer(self, srcUrl, srcAttr, destUrl, destAttr, marker, offset, endOffset, callback, arg)Transfer part of a file between two ftp servers. When the transfer is complete, the complete callback will be called with the final status of the transfer.
|
put(self, url, callback, arg, attr=None, marker=None)Store a file on an ftp server. After calling this method, register_write can be called to begin writing the data. When all of the data associated with this URL is sent, and all of the data callbacks have completed, or if the put request is aborted, the complete callback will be called with the final status of the put.
|
register_read(self, buffer, callback, arg)Register a data buffer to handle part of the ftp data transfer. This can only be called after get or partial get has been called.
|
register_write(self, buffer, size, offset, eof, callback, arg)Register a data buffer to handle part of the ftp data transfer. This can only be called after put or partial put has been called.
|
rmdir(self, url, attr, callback, arg)Remove a directory on a ftp server. The callback will be called with the final status of the rmdir.
|
size(self, url, callback, arg, attr=None)Retrieves the size of a file on a ftp server When the size is retrieved the complete callback is called
|
third_party_transfer(self, srcUrl, destUrl, callback, arg, srcAttr=None, destAttr=None, marker=None)Transfer a file between two ftp servers. When the transfer is complete, the complete callback will be called with the final status of the transfer.
|
verbose_list(self, url, attr, callback, arg)Get a file listing from an ftp server. This method starts a ' LIST' transfer from an ftp server. The client may begin calling register_read to retrieve the listing, after this method returns. When all of the data associated with the listing is returned, and all of the data callbacks executed, the callback will be called with the final status of the list.
|
Home | Trees | Index | Help |
---|
Generated by Epydoc 2.1 on Tue Apr 4 14:32:53 2006 | http://epydoc.sf.net |