Package pyGlobus :: Module ftpClient :: Class FtpClient
[show private | hide private]
[frames | no frames]

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
  __init__(self, handleAttr, handle)
Constructs an instance.
  __del__(self)
Destroy an instance.
  delete(self, url, attr, callback, arg)
Delete a file from a ftp server.
  exists(self, url, callback, arg, attr)
Determines whether a file exists on a ftp server
  extended_get(self, url, eret_alg_str, callback, arg, attr, marker)
Get a file from an ftp server with server-side processing..
  extended_put(self, url, esto_alg_str, callback, arg, attr, marker)
Store a file on an ftp server with server-side processing.
  extended_third_party_transfer(self, srcUrl, eret_alg_str, destUrl, esto_alg_str, callback, arg, srcAttr, destAttr, marker)
Transfer a file between two ftp servers with server-side processing.
  free_callback(self, cbHandle)
Free a callback.
  get(self, url, callback, arg, attr, marker)
Get a file from an ftp server.
  list(self, url, attr, callback, arg)
Get a file listing from an ftp server.
  mkdir(self, url, attr, callback, arg)
Make a directory on a ftp server.
  modification_time(self, url, callback, arg, attr)
Retrieves the size of a file on a ftp server
  move(self, srcUrl, destUrl, attr, callback, arg)
Move a file on a ftp server.
  partial_get(self, url, attr, marker, offset, endOffset, callback, arg)
Get part of a file from a ftp server.
  partial_put(self, url, attr, marker, offset, endOffset, callback, arg)
Put part of a file onto a ftp server.
  partial_third_party_transfer(self, srcUrl, srcAttr, destUrl, destAttr, marker, offset, endOffset, callback, arg)
Transfer part of a file between two ftp servers.
  put(self, url, callback, arg, attr, marker)
Store a file on an ftp server.
  register_read(self, buffer, callback, arg)
Register a data buffer to handle part of the ftp data transfer.
  register_write(self, buffer, size, offset, eof, callback, arg)
Register a data buffer to handle part of the ftp data transfer.
  rmdir(self, url, attr, callback, arg)
Remove a directory on a ftp server.
  size(self, url, callback, arg, attr)
Retrieves the size of a file on a ftp server
  third_party_transfer(self, srcUrl, destUrl, callback, arg, srcAttr, destAttr, marker)
Transfer a file between two ftp servers.
  verbose_list(self, url, attr, callback, arg)
Get a file listing from an ftp server.
    Inherited from BaseFtpClient
  abort(self)
Abort the current operation.
  add_plugin(self, plugin)
Add a plugin to an FTP client handle.
  cache_url_state(self, url)
Cache the connection to the FTP server.
  flush_url_state(self, url)
Remove the url from the connection cache.
  get_handle(self)
Return the underlying ftp client handle.
  get_user_data(self)
Returns the user data associated with the handle.
  remove_plugin(self, plugin)
Remove a plugin to an FTP client handle.
  set_user_data(self, data)
Associate some data with the handle.

Method Details

__init__(self, handleAttr, handle=None)
(Constructor)

Constructs an instance.

Create a new FtpClient instance. This will init the ftp client module and create a new ftp client handle if none is passed in.
Parameters:
handleAttr - A HandleAttr object with the attributes set for this object.
handle - If a SWIG'ized pointer to a globus ftp client handle object is passed in, create a new instance around this handle. The class then owns the underlying pointer, and will delete it when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to init the module or create the underlying handle.
Overrides:
pyGlobus.ftpClient.BaseFtpClient.__init__

__del__(self)
(Destructor)

Destroy an instance.

Free's any remaining callbacks, destroyes the underlying handle, and deactivates the module.
Raises:
FtpClientException - A FtpClientException is thrown if unable to destroy the handle or deactivate the module.

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.
Parameters:
url - The URL to delete.
attr - An OperationAttr object containing the attributes for this delete.
callback -

The function to be called when the delete is completed. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initiate the delete.
Overrides:
pyGlobus.ftpClient.BaseFtpClient.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
Parameters:
url - the location of the file
callback - The function to be called when the modification time of the url has been retrieved. It has the following signature:
  • 'function(arg, handle, error)' where arg is the argument passed into this
call, handle is a SWIG'ized 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.
arg -

A user argument to be returned when the callback is executed.

the default OperationAttr is created and used
Returns:
a boolean indicating whether the file exists
Raises:
FtpClientException - A FtpClientException if the existence cannot be determined
Overrides:
pyGlobus.ftpClient.BaseFtpClient.exists

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.
Parameters:
url - The url to download.
eret_alg_str - The ERET algorithm string. This string contains information needed to invoke a server-specific data reduction algorithm on the file being retrieved.
callback -

The function to be called when the get is completed. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
attr - An OperationAttr object containing the attributes for this get.
marker - A RestartMarker object.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initiate the extended_get.

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.
Parameters:
url - The url to store the data to.
esto_alg_str - The algorith string. This string contains information needed to invoke a server-specific data reduction algorithm on the file being put.
callback -

The function to be called when the put is completed. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
attr - An OperationAttr object containing the attributes for this put.
marker - A RestartMarker object.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initiate the put.

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.
Parameters:
srcUrl - The url to transfer.
eret_alg_str - The algorithm string for the source server. This string contains information needed to invoke a server-specific data reduction algorithm on the file being retrieved.
destUrl - The url to store the data to.
esto_alg_str - The algorithm string for the dest server. This string contains information needed to invoke a server-specific data reduction algorithm on the file being placed.
callback -

The function to be called when the transfer is completed. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
srcAttr - An OperationAttr object containing the attributes for the source.
destAttr - An OperationAttr object containing the attributes for the destination.
marker - A RestartMarker object.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initiate the transfer.

free_callback(self, cbHandle)

Free a callback.

Free's the underlying memory allocated for a callback structure.
Parameters:
cbHandle - A SWIG'ized pointer to 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.
Parameters:
url - The url to download.
callback -

The function to be called when the get is completed. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
attr - An OperationAttr object containing the attributes for this get.
marker - A RestartMarker object.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initiate the get.
Overrides:
pyGlobus.ftpClient.BaseFtpClient.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.
Parameters:
url - The url to list.
attr - An OperationAttr object containing the attributes for the listing.
callback -

The function to be called when the list is completed. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initiate the list.
Overrides:
pyGlobus.ftpClient.BaseFtpClient.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.
Parameters:
url - The URL to make.
attr - An OperationAttr object containing the attributes for this mkdir.
callback -

The function to be called when the mkdir is completed. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initi ate the mkdir.
Overrides:
pyGlobus.ftpClient.BaseFtpClient.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
Parameters:
callback -

The function to be called when the modification time of the url has been retrieved. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
Returns:
An util.Abstime object.
Raises:
FtpClientException - A FtpClientException if the modification time cannot be retrieved
Overrides:
pyGlobus.ftpClient.BaseFtpClient.modification_time

Warning: the Abstime object's underlying timeval struct will not be filled with any

  • * url the location of the file
the default OperationAttr is created and used

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.
Parameters:
srcUrl - The url to move.
destUrl - The url to move to.
attr - An OperationAttr object containing the attributes for the listing.
callback -

The function to be called when the move is completed. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initiate the move.
Overrides:
pyGlobus.ftpClient.BaseFtpClient.move

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.
Parameters:
url - The url to download.
attr - An OperationAttr object containing the attributes for this get.
marker - A RestartMarker object.
offset - An int or long offset to begin the transfer at.
endOffset - An int or long offset to end the transfer at.
callback -

The function to be called when the partial get is completed. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initiate the partial get.
Overrides:
pyGlobus.ftpClient.BaseFtpClient.partial_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.
Parameters:
url - The url to download.
attr - An OperationAttr object containing the attributes for this partial_put.
marker - A RestartMarker object.
offset - An int or long offset to begin the transfer at.
endOffset - An int or long offset to end the transfer at.
callback -

The function to be called when the partial put is completed. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initiate the partial put.
Overrides:
pyGlobus.ftpClient.BaseFtpClient.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.
Parameters:
srcUrl - The url to transfer.
srcAttr - An OperationAttr object containing the attributes for the source.
destUrl - The url to store the data to.
destAttr - An OperationAttr object containing the attributes for the destination.
marker - A RestartMarker object.
offset - An int or long offset to start the transfer from.
endOffset - An int or long offset to end the transfer at.
callback -

The function to be called when the transfer is completed. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initiate the transfer.
Overrides:
pyGlobus.ftpClient.BaseFtpClient.partial_third_party_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.
Parameters:
url - The url to store the data to.
callback -

The function to be called when the put is completed. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
attr - An OperationAttr object containing the attributes for this put.
marker - A RestartMarker object.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initiate the put.
Overrides:
pyGlobus.ftpClient.BaseFtpClient.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.
Parameters:
buffer - A pyGlobus.util.Buffer object.. This hides the internal globus_byte_t data buffer.
callback -

The function to be called after the data has been read. It has the following signature:

'function(arg, handle, buffer, bufHandle, bufLen, offset, eof, error)' where arg is the user argument passed into this call, handle is the underlying ftp_client handle, buffer is a Python buffer object, bufHandle is a SWIG'ized pointer to the underlying globus_byte_t array, bufLen is the length of the underlying globus_byte_t array, offset is the offset into the file this data block contains, eof is a bool that is true if the end of the data transfer has been reached, 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.
arg - A user argument to be passed through to the callback.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initiate the read.

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.
Parameters:
buffer - A string of the data to be written out.
size - The length of the buffer.
offset - The offset of the buffer to be written. In extended block mode the data doesn't need to be sent in order.
eof - True if this buffer contains the end of the data.
callback - The function to be called after the data has been written. It has the following signature: 'function(arg, handle, buffer, bufHandle, bufLen, offset, eof, error)' where arg is the user argument passed into this call, handle is the underlying ftp_client handle, buffer is a Python buffer object, bufHandle is a SWIG'ized pointer to the underlying globus_byte_t array, bufLen is the length of the underlying globus_byte_t array, offset is the offset into the file this dta block contains, eof is a bool that is true if the end of the data transfer has been reached, 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.
arg - A user argument to be passed through to the callback.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initiate the write.

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.
Parameters:
url - The URL to remove.
attr - An OperationAttr object containing the attributes for this rmdir.
callback -

The function to be called when the rmdir is completed. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initiate the rmdir.
Overrides:
pyGlobus.ftpClient.BaseFtpClient.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
Parameters:
url -

the location of the file

the default OperationAttr is created and used
callback -

The function to be called when the file size has been retrieved. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
Returns:
An util.Off_t object, to get the size call getLong on this object, after the callback has returned.
Raises:
FtpClientException - A FtpClientException if the size can't be retrieved
Overrides:
pyGlobus.ftpClient.BaseFtpClient.size

Warning: the object underlying globus_off_t pointer will not be filled with any

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.
Parameters:
srcUrl - The url to transfer.
destUrl - The url to store the data to.
callback -

The function to be called when the transfer is completed. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
srcAttr - An OperationAttr object containing the attributes for the source.
destAttr - An OperationAttr object containing the attributes for the destination.
marker - A RestartMarker object.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initiate the transfer.
Overrides:
pyGlobus.ftpClient.BaseFtpClient.third_party_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.
Parameters:
url - The url to list.
attr - An OperationAttr object containing the attributes for the listing.
callback -

The function to be called when the list is completed. It has the following signature:

'function(arg, handle, error)' where arg is the argument passed into this call, handle is a SWIG'ized 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.
arg - A user argument to be returned when the callback is executed.
Returns:
A SWIG'ized pointer to the callback handle is returned. After the callback completes, this may be free'd with the free_callback method, or it will be free'd when the instance is destroyed.
Raises:
FtpClientException - A FtpClientException is thrown if unable to initiate the list.
Overrides:
pyGlobus.ftpClient.BaseFtpClient.verbose_list

Generated by Epydoc 2.1 on Tue Apr 4 14:32:53 2006 http://epydoc.sf.net