.TH "globus_ftp_client_perf_plugin" 3 "Tue Jul 5 2022" "Version 9.8" "globus_ftp_client" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_ftp_client_perf_plugin \- Performance Marker Plugin
.PP
 \- Performance Marker Plugin\&.  

.SH SYNOPSIS
.br
.PP
.SS "Macros"

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

.in +1c
.ti -1c
.RI "typedef void(* \fBglobus_ftp_client_perf_plugin_begin_cb_t\fP) (void *user_specific, \fBglobus_ftp_client_handle_t\fP *handle, const char *source_url, const char *dest_url, globus_bool_t restart)"
.br
.ti -1c
.RI "typedef void(* \fBglobus_ftp_client_perf_plugin_marker_cb_t\fP) (void *user_specific, \fBglobus_ftp_client_handle_t\fP *handle, long time_stamp_int, char time_stamp_tenth, int stripe_ndx, int num_stripes, globus_off_t nbytes)"
.br
.ti -1c
.RI "typedef void(* \fBglobus_ftp_client_perf_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_perf_plugin_user_copy_cb_t\fP) (void *user_specific)"
.br
.ti -1c
.RI "typedef void(* \fBglobus_ftp_client_perf_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_perf_plugin_init\fP (\fBglobus_ftp_client_plugin_t\fP *plugin, \fBglobus_ftp_client_perf_plugin_begin_cb_t\fP begin_cb, \fBglobus_ftp_client_perf_plugin_marker_cb_t\fP marker_cb, \fBglobus_ftp_client_perf_plugin_complete_cb_t\fP complete_cb, void *user_specific)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_ftp_client_perf_plugin_set_copy_destroy\fP (\fBglobus_ftp_client_plugin_t\fP *plugin, \fBglobus_ftp_client_perf_plugin_user_copy_cb_t\fP copy_cb, \fBglobus_ftp_client_perf_plugin_user_destroy_cb_t\fP destroy_cb)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_ftp_client_perf_plugin_destroy\fP (\fBglobus_ftp_client_plugin_t\fP *plugin)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_ftp_client_perf_plugin_get_user_specific\fP (\fBglobus_ftp_client_plugin_t\fP *plugin, void **user_specific)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Performance Marker Plugin\&. 

The FTP Performance Marker plugin allows the user to obtain performance markers for all types of transfers except a third party transfer in which Extended Block mode is not enabled\&.
.PP
These markers may be generated internally, or they may be received from a server ('put' or third_party_transfer' only)\&.
.PP
Copy constructor and destructor callbacks are also provided to allow one to more easily layer other plugins on top of this one\&. 
.SH "Macro Definition Documentation"
.PP 
.SS "#define GLOBUS_FTP_CLIENT_PERF_PLUGIN_MODULE   (&globus_i_ftp_client_perf_plugin_module)"
Module descriptor 
.SH "Typedef Documentation"
.PP 
.SS "typedef void(* globus_ftp_client_perf_plugin_begin_cb_t) (void *user_specific, \fBglobus_ftp_client_handle_t\fP *handle, const char *source_url, const char *dest_url, globus_bool_t restart)"
Transfer begin callback
.PP
This callback is called when a get, put, or third party transfer is started\&. Note that it is possible for this callback to be made multiple times before ever receiving the complete callback\&.\&.\&. this would be the case if a transfer was restarted\&. The 'restart' will indicate whether or not we have been restarted\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP this the client handle that this transfer will be occurring on
.br
\fIuser_specific\fP this is user specific data either created by the copy method, or, if a copy method was not specified, the value passed to init
.br
\fIsource_url\fP source of the transfer (GLOBUS_NULL if 'put')
.br
\fIdest_url\fP dest of the transfer (GLOBUS_NULL if 'get')
.br
\fIrestart\fP boolean indicating whether this callback is result of a restart
.RE
.PP
\fBReturns\fP
.RS 4
.IP "\(bu" 2
n/a 
.PP
.RE
.PP

.SS "typedef void(* globus_ftp_client_perf_plugin_complete_cb_t) (void *user_specific, \fBglobus_ftp_client_handle_t\fP *handle, globus_bool_t success)"
Transfer complete callback
.PP
This callback will be called upon transfer completion (successful or otherwise)
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP this the client handle that this transfer was occurring on
.br
\fIuser_specific\fP this is user specific data either created by the copy method, or, if a copy method was not specified, the value passed to init
.br
\fIsuccess\fP indicates whether this transfer completed successfully or was interrupted (by error or abort)
.RE
.PP
\fBReturns\fP
.RS 4
.IP "\(bu" 2
n/a 
.PP
.RE
.PP

.SS "typedef void(* globus_ftp_client_perf_plugin_marker_cb_t) (void *user_specific, \fBglobus_ftp_client_handle_t\fP *handle, long time_stamp_int, char time_stamp_tenth, int stripe_ndx, int num_stripes, globus_off_t nbytes)"
Performance marker received callback
.PP
This callback is called for all types of transfers except a third party in which extended block mode is not used (because 112 perf markers won't be sent in that case)\&. For extended mode 'put' and '3pt', actual 112 perf markers will be used and the frequency of this callback is dependent upon the frequency those messages are received\&. For 'put' in which extended block mode is not enabled and 'get' transfers, the information in this callback will be determined locally and the frequency of this callback will be at a maximum of one per second\&.
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP this the client handle that this transfer is occurring on
.br
\fIuser_specific\fP this is user specific data either created by the copy method, or, if a copy method was not specified, the value passed to init
.br
\fItime_stamp_int\fP the timestamp at which the number of bytes is valid (integer part)
.br
\fItime_stamp_tenth\fP the timestamp at which the number of bytes is valid (tenth part)
.br
\fIstripe_ndx\fP the stripe index this data refers to
.br
\fInum_stripes\fP total number of stripes involved in this transfer
.br
\fInbytes\fP the total bytes transferred on this stripe
.RE
.PP
\fBReturns\fP
.RS 4
.IP "\(bu" 2
n/a 
.PP
.RE
.PP

.SS "typedef void*(* globus_ftp_client_perf_plugin_user_copy_cb_t) (void *user_specific)"
Copy constructor
.PP
This callback will be called when a copy of this plugin is made, it is intended to allow initialization of a new user_specific data
.PP
\fBParameters\fP
.RS 4
\fIuser_specific\fP this is user specific data either created by this copy method, or the value passed to init
.RE
.PP
\fBReturns\fP
.RS 4
.IP "\(bu" 2
a pointer to a user specific piece of data
.IP "\(bu" 2
GLOBUS_NULL (does not indicate error) 
.PP
.RE
.PP

.SS "typedef void(* globus_ftp_client_perf_plugin_user_destroy_cb_t) (void *user_specific)"
Destructor
.PP
This callback will be called when a copy of this plugin is destroyed, it is intended to allow the user to free up any memory associated with the user specific data
.PP
\fBParameters\fP
.RS 4
\fIuser_specific\fP this is user specific data created by the copy method
.RE
.PP
\fBReturns\fP
.RS 4
.IP "\(bu" 2
n/a 
.PP
.RE
.PP

.SH "Function Documentation"
.PP 
.SS "globus_result_t globus_ftp_client_perf_plugin_destroy (\fBglobus_ftp_client_plugin_t\fP * plugin)"
Destroy performance marker plugin
.PP
Frees up memory associated with plugin
.PP
\fBParameters\fP
.RS 4
\fIplugin\fP plugin previously initialized with init (above)
.RE
.PP
\fBReturns\fP
.RS 4
.IP "\(bu" 2
GLOBUS_SUCCESS
.IP "\(bu" 2
Error on NULL plugin 
.PP
.RE
.PP

.SS "globus_result_t globus_ftp_client_perf_plugin_get_user_specific (\fBglobus_ftp_client_plugin_t\fP * plugin, void ** user_specific)"
Retrieve user specific pointer
.PP
\fBParameters\fP
.RS 4
\fIplugin\fP plugin previously initialized with init (above)
.br
\fIuser_specific\fP pointer to storage for user_specific pointer
.RE
.PP
\fBReturns\fP
.RS 4
.IP "\(bu" 2
GLOBUS_SUCCESS
.IP "\(bu" 2
Error on NULL plugin
.IP "\(bu" 2
Error on NULL user_specific 
.PP
.RE
.PP

.SS "globus_result_t globus_ftp_client_perf_plugin_init (\fBglobus_ftp_client_plugin_t\fP * plugin, \fBglobus_ftp_client_perf_plugin_begin_cb_t\fP begin_cb, \fBglobus_ftp_client_perf_plugin_marker_cb_t\fP marker_cb, \fBglobus_ftp_client_perf_plugin_complete_cb_t\fP complete_cb, void * user_specific)"
Initialize a perf plugin
.PP
This function initializes a performance marker plugin\&. Any params except for the plugin may be GLOBUS_NULL
.PP
\fBParameters\fP
.RS 4
\fIplugin\fP a pointer to a plugin type to be initialized
.br
\fIuser_specific\fP a pointer to some user specific data that will be provided to all callbacks
.br
\fIbegin_cb\fP the callback to be called upon the start of a transfer
.br
\fImarker_cb\fP the callback to be called with every performance marker received
.br
\fIcomplete_cb\fP the callback to be called to indicate transfer completion
.RE
.PP
\fBReturns\fP
.RS 4
.IP "\(bu" 2
GLOBUS_SUCCESS
.IP "\(bu" 2
Error on NULL plugin
.IP "\(bu" 2
Error on init internal plugin 
.PP
.RE
.PP

.SS "globus_result_t globus_ftp_client_perf_plugin_set_copy_destroy (\fBglobus_ftp_client_plugin_t\fP * plugin, \fBglobus_ftp_client_perf_plugin_user_copy_cb_t\fP copy_cb, \fBglobus_ftp_client_perf_plugin_user_destroy_cb_t\fP destroy_cb)"
Set user copy and destroy callbacks
.PP
Use this to have the plugin make callbacks any time a copy of this plugin is being made\&. This will allow the user to keep state for different handles\&.
.PP
\fBParameters\fP
.RS 4
\fIplugin\fP plugin previously initialized with init (above)
.br
\fIcopy_cb\fP func to be called when a copy is needed
.br
\fIdestroy_cb\fP func to be called when a copy is to be destroyed
.RE
.PP
\fBReturns\fP
.RS 4
.IP "\(bu" 2
Error on NULL arguments
.IP "\(bu" 2
GLOBUS_SUCCESS 
.PP
.RE
.PP

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