.TH "globus_ftp_client_throughput_plugin.h" 3 "Wed Feb 27 2019" "Version 9.2" "globus_ftp_client" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_ftp_client_throughput_plugin.h \- GridFTP Throughput Performance Plugin Implementation\&.  

.SH SYNOPSIS
.br
.PP
\fC#include 'globus_ftp_client\&.h'\fP
.br
\fC#include 'globus_ftp_client_plugin\&.h'\fP
.br

.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_FTP_CLIENT_THROUGHPUT_PLUGIN_MODULE\fP   (&globus_i_ftp_client_throughput_plugin_module)"
.br
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef void(* \fBglobus_ftp_client_throughput_plugin_begin_cb_t\fP) (void *user_specific, \fBglobus_ftp_client_handle_t\fP *handle, const char *source_url, const char *dest_url)"
.br
.ti -1c
.RI "typedef void(* \fBglobus_ftp_client_throughput_plugin_stripe_cb_t\fP) (void *user_specific, \fBglobus_ftp_client_handle_t\fP *handle, int stripe_ndx, globus_off_t bytes, float instantaneous_throughput, float avg_throughput)"
.br
.ti -1c
.RI "typedef void(* \fBglobus_ftp_client_throughput_plugin_total_cb_t\fP) (void *user_specific, \fBglobus_ftp_client_handle_t\fP *handle, globus_off_t bytes, float instantaneous_throughput, float avg_throughput)"
.br
.ti -1c
.RI "typedef void(* \fBglobus_ftp_client_throughput_plugin_complete_cb_t\fP) (void *user_specific, \fBglobus_ftp_client_handle_t\fP *handle, globus_bool_t success)"
.br
.ti -1c
.RI "typedef void *(* \fBglobus_ftp_client_throughput_plugin_user_copy_cb_t\fP) (void *user_specific)"
.br
.ti -1c
.RI "typedef void(* \fBglobus_ftp_client_throughput_plugin_user_destroy_cb_t\fP) (void *user_specific)"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_ftp_client_throughput_plugin_init\fP (\fBglobus_ftp_client_plugin_t\fP *plugin, \fBglobus_ftp_client_throughput_plugin_begin_cb_t\fP begin_cb, \fBglobus_ftp_client_throughput_plugin_stripe_cb_t\fP per_stripe_cb, \fBglobus_ftp_client_throughput_plugin_total_cb_t\fP total_cb, \fBglobus_ftp_client_throughput_plugin_complete_cb_t\fP complete_cb, void *user_specific)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_ftp_client_throughput_plugin_set_copy_destroy\fP (\fBglobus_ftp_client_plugin_t\fP *plugin, \fBglobus_ftp_client_throughput_plugin_user_copy_cb_t\fP copy_cb, \fBglobus_ftp_client_throughput_plugin_user_destroy_cb_t\fP destroy_cb)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_ftp_client_throughput_plugin_destroy\fP (\fBglobus_ftp_client_plugin_t\fP *plugin)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_ftp_client_throughput_plugin_get_user_specific\fP (\fBglobus_ftp_client_plugin_t\fP *plugin, void **user_specific)"
.br
.in -1c
.SH "Detailed Description"
.PP 
GridFTP Throughput Performance Plugin Implementation\&. 


.SH "Author"
.PP 
Generated automatically by Doxygen for globus_ftp_client from the source code\&.