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

Class PerformanceMarkerPlugin

Plugin --+
         |
        PerformanceMarkerPlugin


A wrapper class around the ftp client performance marker plugin.

This plugin provides performance marker information via callbacks on all types of transfers except third_party_transfers w/o extended block mode transfer. During a transfer, every marker received will result in the user's 'marker' callback being called with new performance markers that can be stored.
Method Summary
  __init__(self, beginCB, markerCB, completeCB, arg)
Initialize an instance of the GridFTP performance marker plugin.
  __del__(self)
Destroy an instance of the GridFTP restart marker plugin.
    Inherited from Plugin
  get_handle(self)
Return the underlying ftp client plugin handle.

Method Details

__init__(self, beginCB, markerCB, completeCB, arg)
(Constructor)

Initialize an instance of the GridFTP performance marker plugin.

This function will initialize the performance marker plugin-specific instance data for this plugin, and will make the plugin usable for ftp client handle attribute and handle creation.
Parameters:
beginCB -

The callback to be called upon the start of the transfer. It has the following signature

'function(arg, handle, srcUrl, destUrl, restart)' where arg is the argument passed into this call, handle is a SWIG'ized pointer to a ftp client handle object, srcUrl is the a string representing the source url, destUrl is the a string representing the destination url, is an int indicating whether this callback is the result of a restart
markerCB -

The callback to be called with each performance marker received. It has the following signature

'function(arg, handle, time_stamp, time_stamp_length, stripe_ndx, num_stripes, nbytes)' where arg is the argument passed into this call, handle is a SWIG'ized pointer to a ftp client handle object, time_stamp is an int indicating the timestamp at which the number of bytes is valid, time_stamp_length (not documented and I haven't gotten this to work MKR), stripe_ndx an int indicating the stripe index this data refers to, num_stripes an int indicating the total number of stripes involved in this transfer, nbytes an int indicating the total bytes transfered on this stripe.
completeCB -

The callback to be called to indicate transfer completion. 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, 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 - An arbitary argument to be passed to all the callbacks.
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 restart marker 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:56 2006 http://epydoc.sf.net