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

Class BaseFtpClient

Known Subclasses:
EasyFtpClient, FtpClient

Parent Class for the FtpClient and EasyFtpClient classes
Method Summary
  __init__(self)
  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.
  delete(self, *argslist)
  exists(self, *argslist)
  flush_url_state(self, url)
Remove the url from the connection cache.
  get(self, *argslist)
  get_handle(self)
Return the underlying ftp client handle.
  get_user_data(self)
Returns the user data associated with the handle.
  list(self, *argslist)
  mkdir(self, *argslist)
  modification_time(self, *argslist)
  move(self, *argslist)
  partial_get(self, *argslist)
  partial_put(self, *argslist)
  partial_third_party_transfer(self, *argslist)
  put(self, *argslist)
  remove_plugin(self, plugin)
Remove a plugin to an FTP client handle.
  rmdir(self, *argslist)
  set_user_data(self, data)
Associate some data with the handle.
  size(self, *argslist)
  third_party_transfer(self, *argslist)
  verbose_list(self, *argslist)

Method Details

abort(self)

Abort the current operation.
Raises:
FtpClientException - A FtpClientException is thrown if an error occurs while aborting the current operation.

add_plugin(self, plugin)

Add a plugin to an FTP client handle.

This function adds a plugin to an FTP client handle after it has been created. Plugins may be added to an ftp client handle whenever an operation is not in progress. The plugin will be appended to the list of plugins present in the handle, and will be invoked during any subsequent operations processed with this handle.

Only one instance of a particular plugin may be added to a particular handle.
Parameters:
plugin - A Plugin class.
Raises:
FtpClientException - A FtpClientException is thrown if unable to add the plugin.

cache_url_state(self, url)

Cache the connection to the FTP server.

When the url is cached, the library will not close the connection after completing an operation.
Parameters:
url - The URL of the server to cache.
Raises:
FtpClientException - A FtpClientException is thrown if unable to cache the url state.

flush_url_state(self, url)

Remove the url from the connection cache.

If an idle connection to the server exists, it will be closed.
Parameters:
url - The URL to remove from the cache.
Raises:
FtpClientException - A FtpClientException is thrown if unable to flush the url state.

get_handle(self)

Return the underlying ftp client handle.
Returns:
A string containing the pointer.

Warning: This handle is only valid as long as this object exists. When

get_user_data(self)

Returns the user data associated with the handle.

Access to this data is not synchronized.
Returns:
The data set with the set_user_data method.
Raises:
FtpClientException - A FtpClientException is thrown if unable to get the data.

remove_plugin(self, plugin)

Remove a plugin to an FTP client handle.

This function removes a plugin from an FTP client handle after it has been created. Plugins may be removed from an ftp client handle whenever an operation is not in progress. The plugin will be removed from the list of plugins, and will not be used during any subsequent operations processed with this handle.
Parameters:
plugin - A Plugin class.
Raises:
FtpClientException - A FtpClientException is thrown if unable to remove the plugin.

set_user_data(self, data)

Associate some data with the handle.

Access to this data is not synchronized.
Parameters:
data - The user data to set.
Raises:
FtpClientException - A FtpClientException is thrown if unable to set the data.

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