Package pyGlobus :: Module ftpClientPlugin :: Class DebugPlugin
[show private | hide private]
[frames | no frames]

Class DebugPlugin

Plugin --+
         |
        DebugPlugin


A wrapper class around the ftp client debug plugin.

The FTP Debugging plugin provides a way for the user to trace FTP protocol messages which occur while the GridFTP client library processes an FTP operation. This may be useful for debugging FTP configuration problems.

When this plugin is used for a GridFTP Client operation, information will be printed to the file stream associated with the plugin when a user begins an operation, for all data buffers which pass through while handling a data transfer, and for all protocol messages which are sent and received.
Method Summary
  __init__(self, file, text)
Initialize an instance of the GridFTP debugging plugin.
  __del__(self)
Destroy an instance of the GridFTP debugging plugin.
    Inherited from Plugin
  get_handle(self)
Return the underlying ftp client plugin handle.

Method Details

__init__(self, file, text)
(Constructor)

Initialize an instance of the GridFTP debugging plugin.

This function will initialize the debugging plugin-specific instance data for this plugin, and will make the plugin usable for ftp client handle attribute and handle creation.
Parameters:
file - An open Python file object to write the debug messages to.
text - A string message to append to the debug info.
Raises:
PluginException - A PluginException is thrown if unable to init the plugin.
Overrides:
pyGlobus.ftpClientPlugin.Plugin.__init__

__del__(self)
(Destructor)

Destroy an instance of the GridFTP debugging plugin.

This function will free all debugging plugin-specific instance data from this plugin, and will make the plugin unusable for further ftp handle creation.

Existing FTP client handles and handle attributes will not be affected by destroying a plugin associated with them, as a local copy of the plugin is made upon handle initialization.
Raises:
PluginException - A PluginException is thrown if unable to destroy the plugin.

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