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

Class NetloggerPlugin

Plugin --+
         |
        NetloggerPlugin


A wrapper class around the netlogger plugin.
Method Summary
  __init__(self, nl_url, prog_name, opaque_string)
Initialize an instance of the netlogger plugin.
  __del__(self)
Destroy an instance of the netlogger plugin.
    Inherited from Plugin
  get_handle(self)
Return the underlying ftp client plugin handle.

Method Details

__init__(self, nl_url, prog_name, opaque_string=None)
(Constructor)

Initialize an instance of the netlogger plugin.

This function will initialize the NetloggerPlugin instance data for this plugin, and will make the plugin usable for ftp client handle attribute and handle creation.
Parameters:
nl_url - the url to log to. (May be None) Valid urls are: file://tmp/netlog.log, x-netlog://host[:port], x-syslog://localhost
prog_name - This is used as the prog name in the NetLoggerOpen call
opaque_string - this is an opaque string that will be inserted into all logged statements. (may be None)
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 netlogger 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:52 2006 http://epydoc.sf.net