.TH "globus_ftp_client_debug_plugin" 3 "Wed Feb 27 2019" "Version 9.2" "globus_ftp_client" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_ftp_client_debug_plugin \- Debugging Plugin\&.  

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

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_FTP_CLIENT_DEBUG_PLUGIN_MODULE\fP   (&globus_i_ftp_client_debug_plugin_module)"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_ftp_client_debug_plugin_init\fP (\fBglobus_ftp_client_plugin_t\fP *plugin, FILE *stream, const char *text)"
.br
.ti -1c
.RI "globus_result_t \fBglobus_ftp_client_debug_plugin_destroy\fP (\fBglobus_ftp_client_plugin_t\fP *plugin)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Debugging Plugin\&. 

The FTP Debugging plugin provides a way for the user to trace FTP protocol messages which occur while the GridFTP client library processes an FTP operation\&. This may be useful for debugging FTP configuration problems\&.
.PP
When this plugin is used for a GridFTP Client operation, information will be printed to the file stream associated with the plugin when a user begins an operation, for all data buffers which pass through while handling a data transfer, and for all protocol messages which are sent and received\&. 
.SH "Macro Definition Documentation"
.PP 
.SS "#define GLOBUS_FTP_CLIENT_DEBUG_PLUGIN_MODULE   (&globus_i_ftp_client_debug_plugin_module)"
Module descriptor 
.SH "Function Documentation"
.PP 
.SS "globus_result_t globus_ftp_client_debug_plugin_destroy (\fBglobus_ftp_client_plugin_t\fP * plugin)"
Destroy an instance of the GridFTP debugging plugin
.PP
This function will free all debugging plugin-specific instance data from this plugin, and will make the plugin unusable for further ftp handle creation\&.
.PP
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\&.
.PP
\fBParameters:\fP
.RS 4
\fIplugin\fP A pointer to a GridFTP debugging plugin, previously initialized by calling \fBglobus_ftp_client_debug_plugin_init()\fP
.RE
.PP
\fBReturns:\fP
.RS 4
This function returns an error if
.IP "\(bu" 2
plugin is null
.IP "\(bu" 2
plugin is not a debugging plugin
.PP
.RE
.PP
\fBSee also:\fP
.RS 4
\fBglobus_ftp_client_debug_plugin_init()\fP, \fBglobus_ftp_client_handleattr_add_plugin()\fP, globus_ftp_client_handleattr_remove_plugin(), \fBglobus_ftp_client_handle_init()\fP 
.RE
.PP

.SS "globus_result_t globus_ftp_client_debug_plugin_init (\fBglobus_ftp_client_plugin_t\fP * plugin, FILE * stream, const char * text)"
Initialize an instance of the GridFTP debugging plugin
.PP
This function will initialize the debugging plugin-specific instance data for this plugin, and will make the plugin usable for ftp client handle attribute and handle creation\&.
.PP
\fBParameters:\fP
.RS 4
\fIplugin\fP A pointer to an uninitialized plugin\&. The plugin will be configured as a debugging plugin, with the default of sending debugging messages to stderr\&. 
.br
\fIstream\fP 
.br
\fItext\fP 
.RE
.PP
\fBReturns:\fP
.RS 4
This function returns an error if
.IP "\(bu" 2
plugin is null
.PP
.RE
.PP
\fBSee also:\fP
.RS 4
\fBglobus_ftp_client_debug_plugin_destroy()\fP, \fBglobus_ftp_client_handleattr_add_plugin()\fP, globus_ftp_client_handleattr_remove_plugin(), \fBglobus_ftp_client_handle_init()\fP 
.RE
.PP

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