logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

globus_ftp_client_debug_plugin - Debugging Plugin

Author

       Generated automatically by Doxygen for globus_ftp_client from the source code.

globus_ftp_client                                  Version 9.8                 globus_ftp_client_debug_plugin(3)

Detailed Description

       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.

       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.

Function Documentation

globus_result_tglobus_ftp_client_debug_plugin_destroy(globus_ftp_client_plugin_t*plugin)
       Destroy an instance of the GridFTP debugging 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.

       Parametersplugin A pointer to a GridFTP debugging plugin, previously initialized by calling
           globus_ftp_client_debug_plugin_init()Returns
           This function returns an error if

           • plugin is null

           • plugin is not a debugging plugin

       Seealsoglobus_ftp_client_debug_plugin_init(),                     globus_ftp_client_handleattr_add_plugin(),
           globus_ftp_client_handleattr_remove_plugin(), globus_ftp_client_handle_init()globus_result_tglobus_ftp_client_debug_plugin_init(globus_ftp_client_plugin_t*plugin,FILE*stream,constchar*text)
       Initialize an instance of the GridFTP debugging plugin

       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.

       Parametersplugin A pointer to an uninitialized plugin. The plugin will be configured  as  a  debugging  plugin,
           with the default of sending debugging messages to stderr.
           streamtextReturns
           This function returns an error if

           • plugin is null

       Seealsoglobus_ftp_client_debug_plugin_destroy(),                  globus_ftp_client_handleattr_add_plugin(),
           globus_ftp_client_handleattr_remove_plugin(), globus_ftp_client_handle_init()

Macro Definition Documentation

#defineGLOBUS_FTP_CLIENT_DEBUG_PLUGIN_MODULE(&globus_i_ftp_client_debug_plugin_module)
       Module descriptor

Name

       globus_ftp_client_debug_plugin - Debugging Plugin

        - Debugging Plugin.

Synopsis

Macros
       #define GLOBUS_FTP_CLIENT_DEBUG_PLUGIN_MODULE           (&globus_i_ftp_client_debug_plugin_module)

   Functions
       globus_result_t globus_ftp_client_debug_plugin_init (globus_ftp_client_plugin_t *plugin, FILE *stream,
           const char *text)
       globus_result_t globus_ftp_client_debug_plugin_destroy (globus_ftp_client_plugin_t *plugin)

See Also