Table of Contents

Class: ThoughputPerfPlugin ./pyGlobus/ftpClient.py

A wrapper class around the ftp client throughput performance plugin. This plugin is built on top of the Performance Marker Plugin, it is not possible to associate both plugins with a handle

This plugin provides throughput performance 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.

Base Classes   
Plugin
Methods   
__del__
__init__
  __del__ 
__del__ ( self )

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

A PluginException is thrown if unable to destroy the plugin.

Exceptions   
ex
  __init__ 
__init__ (
        self,
        beginCB,
        stripeCB,
        totalCB,
        completeCB,
        arg,
        )

Initialize an instance of the GridFTP Throughput plugin.

This function will initialize the Throughput plugin-specific instance data for this plugin, and will make the plugin usable for ftp client handle attribute and handle creation.

Arguments

beginCB The callback to be called upon the start of the transfer..

stripeCB The callback to be called with every performance callback that is received by the perf plugin. The first callback for each stripe_ndx will have an instantaneous_throughput based from the time the command was sent.

totalCB The callback will be called with every performance callback that is received by the perf plugin. The first callback for will have an instantaneous_throughput based from the time the command was sent. This callback will be called after the per_stripe_cb

completeCB The callback to be called to indicate transfer completion.

arg An arbitary argument to be passed to all the callbacks.

Raises

A PluginException is thrown if unable to init 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