Home | Trees | Index | Help |
---|
Package pyGlobus :: Module ftpClient :: Class EasyFtpClient |
|
BaseFtpClient
--+
|
EasyFtpClient
A class to wrap the ftp client functions.
Each operation in this class blocks until the operation has completed
There is currently no way to abort an operation
If you must abort an operation use the FtpClient classMethod Summary | |
---|---|
Constructs an instance. | |
Destroy an instance. | |
Delete a file from a ftp server. | |
Callback that has the signature function(arg, handle, error) where arg is the argument passed into this call, handle is a SWIGized pointer to a ftp client handle object, and error is a tuple (error_code, error_description). | |
This callback is for the exists method It is called after the existence check has returned from the ftp Server | |
Determines whether a file exists on a ftp server | |
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. | |
This is a callback function that is for the register_read method It is called when a the buffer is full with data that has arrived to the handle It is used as a data callback for the *get methods | |
Remove a directory on a ftp server. | |
Retrieves the size of a file on a ftp server | |
This function is for doing small reads such as a verbose_list. | |
Transfer a file between two ftp servers. | |
Get a file listing from an ftp server. | |
This is a callback function for the register_write method. | |
This is a callback function for register writes that need to keep track of offsets It is used in the partial_put method | |
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=None,
handle=None)
|
__del__(self)
|
delete(self, url, attr=None)Delete a file from a ftp server. This method blocks until the file has been deleted
|
done_cb(self, cv, handle, error)Callback that has the signature function(arg, handle, error) where arg is the argument passed into this call, handle is a SWIGized pointer to a ftp client handle object, and error is a tuple (error_code, error_description). If there is no error, the error_code is 0 and the error description is a None object. This function handles these types of callbacks in the EasyFtpClient class |
done_cb_exists(self, arglist, handle, error)This callback is for the exists method It is called after the existence check has returned from the ftp Server |
exists(self, url, attr=None)Determines whether a file exists on a ftp server When the existence has been determined the complete callback is called
|
get(self, dest_file, url, 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=None)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=None)Make a directory on a ftp server. The callback will be called with the final status of the mkdir.
|
modification_time(self, url, 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=None)Move a file on a ftp server. The complete callback will be called when the move is completed.
|
partial_get(self, dest_file, url, offset, endOffset, attr=None, marker=None)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, src_file, url, offset, endOffset, attr=None, marker=None)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, destUrl, offset, endOffset, srcAttr=None, destAttr=None, marker=None)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, src_file, url, 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.
|
read_cb(self, fd, handle, buffer, bufHandle, bufLen, offset, eof, error)This is a callback function that is for the register_read method It is called when a the buffer is full with data that has arrived to the handle It is used as a data callback for the *get methods |
rmdir(self, url, attr=None)Remove a directory on a ftp server. The callback will be called with the final status of the rmdir.
|
size(self, url, attr=None)Retrieves the size of a file on a ftp server When the size is retrieved the complete callback is called
|
small_read_cb(self, arg, handle, buffer, bufHandle, bufLen, offset, eof, error)This function is for doing small reads such as a verbose_list. The result is stored in a string, instead of being written to a file |
third_party_transfer(self, srcUrl, destUrl, 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=None)Get a file listing from an ftp server. This method blocks until the list of the url is retrieved 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.
|
write_cb(self, fd, handle, buffer, bufHandle, bufLen, offset, eof, error)This is a callback function for the register_write method. It is called when the handle has recieved the buffer It is used as a data callback for the *put methods |
write_cb_partial(self, args, handle, buffer, bufHandle, bufLen, offset, eof, error)This is a callback function for register writes that need to keep track of offsets It is used in the partial_put method |
Home | Trees | Index | Help |
---|
Generated by Epydoc 2.1 on Tue Apr 4 14:32:54 2006 | http://epydoc.sf.net |