Table of Contents

Class: HandleAttr ./pyGlobus/ftpClient.py

A class to wrap the ftp client handle attr functions.

It provides get and set methods for all of the various handle specific attributes, and hides the underlying memory management.

Methods   
__del__
__init__
add_cached_url
add_plugin
copy
get_cache_all
get_handle
remove_cached_url
remove_plugin
set_cache_all
set_netlogger
  __del__ 
__del__ ( self )

Destroy an instance.

Deletes the ftp attr handle and deactivates the underlying globus module.

Raises:

A HandleAttrException is thrown if unable to destroy the handle or deactivate the module.

Exceptions   
ex
  __init__ 
__init__ (
        self,
        handle=None,
        own=1,
        )

Constructs an instance.

Activates the globus ftp client module and creates the ftp handle attr.

Arguments

  • handle A SWIG'ized pointer to a globus ftp client handleattr pointer. Used to construct an instance from an existing pointer.

  • own True if the class owns the underlying pointer.

Raises:

A HandleAttr exception is thrown if unable to activate the module or create the handle.

Exceptions   
ex
  add_cached_url 
add_cached_url ( self,  url )

Enable caching for the specified url.

The handle will keep the connection to the specified url open in between ftp operations.

Arguments:

  • url The url to cache.

Raises:

A HandleAttrException is thrown if unable to cache the url.

Exceptions   
ex
  add_plugin 
add_plugin ( self,  plugin )

Add a plugin to a handle attribute set.

Each handle attribute set contains a list of plugins associated with it. When a handle is created with a particular attribute set, it will be associated with a copy of those plugins.

Only one instance of a specific plugin may be added to an attribute set. Each plugin must have a different name.

A copy of the plugin is created via the plugins copy method when it is added to an attribute set. Thus, any changes to a particular plugin must be done before the plugin is added to an attribute set, and before the attribute set is used to create handles.

Arguments

plugin A Plugin class.

Raises

An HandleAttrException is thrown if unable to add the plugin.

Exceptions   
ex
  copy 
copy ( self )

Creates a deep copy of itself.

Raises:

A HandleAttrException is thrown if unable to make the copy.

Returns:

A new HandleAttr object with the same properties as the original is returned.

Exceptions   
ex
  get_cache_all 
get_cache_all ( self )

Return the cache all attribute.

If true, all connections on the handle will be cached in between connections. When this is enabled, the user skips the authentication handshake and connection establishment overhead for multiple subsequent ftp operations to the same server.

Raises:

A HandleAttrException is thrown if unable to return the attribute.

Exceptions   
ex
  get_handle 
get_handle ( self )

Return the underlying ftp client handle attr handle.

XXX This handle is only valid as long as this object exists. When the object is destroyed, the memory this handle points to is freed.

Returns:

A string containing the pointer.

  remove_cached_url 
remove_cached_url ( self,  url )

Disable caching for the specified url.

The handle will no longer keep the connection open to the specified url between connections.

Arguments:

  • url The url to remove from the cache.

Raises:

A HandleAttrException is thrown if unable to remove the url from the cache.

Exceptions   
ex
  remove_plugin 
remove_plugin ( self,  plugin )

Remove a plugin from a handle attribute set.

Each handle attribute set contains a list of plugins associated with it. When a handle is created with a particular attribute set, it will be associated with a copy of those plugins.

Only one instance of a specific plugin may be added to an attribute set. Each plugin must have a different name.

A copy of the plugin is created via the plugins copy method when it is added to an attribute set. Thus, any changes to a particular plugin must be done before the plugin is added to an attribute set, and before the attribute set is used to create handles.

Arguments

plugin A Plugin class.

Raises

An HandleAttrException is thrown if unable to remove the plugin.

Exceptions   
ex
  set_cache_all 
set_cache_all ( self,  cacheAll )

Set the cache all attribute.

If true, all connections on the handle will be cached in between connections. When this is enabled, the user skips the authentication handshake and connection establishment overhead for multiple subsequent ftp operations to the same server.

Arguments:

  • cacheAll A boolean describing whether to cache all connections or not.

Raises:

A HandleAttrException is thrown if unable to set the attribute.

Exceptions   
ex
  set_netlogger 
set_netlogger ( self,  nl_handle )

Set netlogger handle.

Arguments

nl_handle A netlogger handle.

Raises

An HandleAttrException is thrown if unable to add the plugin.

???

Exceptions   
ex

Table of Contents

This document was automatically generated on Tue Feb 4 16:47:03 2003 by HappyDoc version 2.1