.TH "globus_ftp_client_throughput_nl_plugin" 3 "Version 9.8" "globus_ftp_client" \" -*- nroff -*- .ad l .nh .SH NAME globus_ftp_client_throughput_nl_plugin \- Netlogger Throughput Plugin .PP \- Netlogger Throughput Plugin\&. .SH SYNOPSIS .br .PP .SS "Macros" .in +1c .ti -1c .RI "#define \fBGLOBUS_FTP_CLIENT_THROUGHPUT_NL_PLUGIN_MODULE\fP (&globus_i_ftp_client_throughput_nl_plugin_module)" .br .in -1c .SS "Functions" .in +1c .ti -1c .RI "globus_result_t \fBglobus_ftp_client_throughput_nl_plugin_init\fP (\fBglobus_ftp_client_plugin_t\fP *plugin, const char *nl_url, const char *prog_name, const char *opaque_string)" .br .ti -1c .RI "globus_result_t \fBglobus_ftp_client_throughput_nl_plugin_init_with_handle\fP (\fBglobus_ftp_client_plugin_t\fP *plugin, NLhandle *nl_handle, const char *opaque_string)" .br .ti -1c .RI "globus_result_t \fBglobus_ftp_client_throughput_nl_plugin_destroy\fP (\fBglobus_ftp_client_plugin_t\fP *plugin)" .br .ti -1c .RI "globus_result_t \fBglobus_ftp_client_throughput_nl_plugin_set_callbacks\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 .in -1c .SH "Detailed Description" .PP Netlogger Throughput Plugin\&. This plugin allows a user to easily use the throughput plugin to log performance data vi Netlogger\&. .PP The plugin will log the following Event Types with its coressponding info .PP TransferPerfTotal : This event type will be sent every time a throughput plugin total callback is received\&. .PP .IP "\(bu" 2 URL\&.SOURCE Source url of transfer .IP "\(bu" 2 URL\&.DEST Dest url of transfer .IP "\(bu" 2 BYTES Total bytes transferred thus far .IP "\(bu" 2 BW\&.CURRENT Current (instantaneous) bandwidth .IP "\(bu" 2 BW\&.AVG Average (instantaneous) bandwidth .PP .PP TransferPerfStripe : This event type will be sent every time a throughput plugin stripe callback is received\&. .PP .IP "\(bu" 2 URL\&.SOURCE Source url of transfer .IP "\(bu" 2 URL\&.DEST Dest url of transfer .IP "\(bu" 2 INDEX The stripe index the event applies to .IP "\(bu" 2 BYTES Total bytes transferred thus far on this stripe .IP "\(bu" 2 BW\&.CURRENT Current (instantaneous) bandwidth on this stripe .IP "\(bu" 2 BW\&.AVG Average (instantaneous) bandwidth on this stripe .PP .PP TransferBegin : This event type will be sent every time a throughput plugin begin callback is received\&. .PP .IP "\(bu" 2 URL\&.SOURCE Source url of transfer .IP "\(bu" 2 URL\&.DEST Dest url of transfer .PP .PP TransferEnd : This event type will be sent every time a throughput plugin complete callback is received\&. .PP .IP "\(bu" 2 SUCCESS Completion status .PP .SH "Macro Definition Documentation" .PP .SS "#define GLOBUS_FTP_CLIENT_THROUGHPUT_NL_PLUGIN_MODULE (&globus_i_ftp_client_throughput_nl_plugin_module)" Module descriptor .SH "Function Documentation" .PP .SS "globus_result_t globus_ftp_client_throughput_nl_plugin_destroy (\fBglobus_ftp_client_plugin_t\fP * plugin)" Destroy netlogger wrapped throughput 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_throughput_nl_plugin_init (\fBglobus_ftp_client_plugin_t\fP * plugin, const char * nl_url, const char * prog_name, const char * opaque_string)" Initialize netlogger wrapped throughput plugin .PP This will initialize a netlogger wrapped throughput plugin\&. Note that the nl_url may be NULL\&. Regardless of what nl_host is set to, if the env variable NL_DEST_ENV is set, logging will always occur to that location\&. .PP \fBParameters\fP .RS 4 \fIplugin\fP a plugin to be initialized .br \fInl_url\fP the url to log to (May be NULL) Valid urls are: file://tmp/netlog.log x-netlog://host[:port] x-syslog://localhost .br \fIprog_name\fP This is used as the prog name in the NetLoggerOpen call .br \fIopaque_string\fP this is an opaque string that will be inserted into all logged statements\&. (may be NULL) .RE .PP \fBReturns\fP .RS 4 .IP "\(bu" 2 Error on NULL plugin or failure to init throughput plugin .IP "\(bu" 2 Error on NetLogger open .IP "\(bu" 2 GLOBUS_SUCCESS .PP .RE .PP .SS "globus_result_t globus_ftp_client_throughput_nl_plugin_init_with_handle (\fBglobus_ftp_client_plugin_t\fP * plugin, NLhandle * nl_handle, const char * opaque_string)" Initialize netlogger wrapped throughput plugin .PP This will initialize a netlogger wrapped throughput plugin\&. Instead of passing a NetLogger url as in the plain init func, you can pass in a previously 'Open'ed NLhandle\&. This handle will not be destroyed by this plugin\&. .PP \fBParameters\fP .RS 4 \fIplugin\fP a plugin to be initialized .br \fInl_handle\fP a previously opened NetLogger handle .br \fIopaque_string\fP this is an opaque string that will be inserted into all logged statements\&. (may be NULL) .RE .PP \fBReturns\fP .RS 4 .IP "\(bu" 2 Error on NULL plugin or failure to init throughput plugin .IP "\(bu" 2 Error on NetLogger open .IP "\(bu" 2 GLOBUS_SUCCESS .PP .RE .PP .SS "globus_result_t globus_ftp_client_throughput_nl_plugin_set_callbacks (\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)" Receive throughput callbacks .PP You can still get the automatic netlogging of throughput along with receiving the same throughput callbacks that the throughput plugin provides by using this function to set these callbacks\&. Note that the callbacks are defined the same as in the throughput plugin .PP \fBParameters\fP .RS 4 \fIplugin\fP .br \fIbegin_cb\fP the callback to be called upon the start of a transfer .br \fIper_stripe_cb\fP the callback to be called every time updated throughput info is available for a given stripe .br \fItotal_cb\fP the callback to be called every time updated throughput info is available for any stripe .br \fIcomplete_cb\fP the callback to be called to indicate transfer completion .br \fIuser_specific\fP a pointer to some user specific data that will be provided to all callbacks .RE .PP \fBReturns\fP .RS 4 .IP "\(bu" 2 Error on NULL or invalid plugin .IP "\(bu" 2 GLOBUS_SUCCESS .PP .RE .PP \fBSee also\fP .RS 4 \fBThroughput Performance Plugin\fP .RE .PP .SH "Author" .PP Generated automatically by Doxygen for globus_ftp_client from the source code\&.