globus_ftp...bug_plugin(3)

📦
version 9.9 · 6 versions
, in epel 10, fedora 43, fedora 44, ubuntu resolute, ubuntu stonking

✨ globus_ftp_client_debug_plugin — Debugging Plugin ✨

okay bestie, welcome to the Library Functions Manual 💖 this is globus_ftp...bug_plugin(3) and it's literally all about the Debugging Plugin. no cap.

🌸 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)

🌈 Detailed Description 🌈

Debugging Plugin. periodt.

So the FTP Debugging plugin is the way you let a user trace FTP protocol messages while the GridFTP client library is processing an FTP operation. it's giving detective energy 🔍 and honestly it's so useful for debugging FTP configuration problems.

When you use this plugin for a GridFTP Client operation, information gets printed to the file stream associated with the plugin:

  • when a user begins an operation 👑
  • for all data buffers that pass through while handling a data transfer 📦
  • for all protocol messages that are sent and received 📨

like... every single one. she's thorough 💅

🧚 Macro Definition Documentation 🧚

#define GLOBUS_FTP_CLIENT_DEBUG_PLUGIN_MODULE

(&globus_i_ftp_client_debug_plugin_module)

Module descriptor ✨

💜 Function Documentation 💜

globus_result_t globus_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. she's done, she's retiring, no more handles for her 🫶

Existing FTP client handles and handle attributes will not be affected by destroying a plugin associated with them, because a local copy of the plugin is made upon handle initialization. so like, don't panic, your handles are safe bestie 💖

Parameters

  • plugin — 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

See also

  • globus_ftp_client_debug_plugin_init()
  • globus_ftp_client_handleattr_add_plugin()
  • globus_ftp_client_handleattr_remove_plugin()
  • globus_ftp_client_handle_init()

globus_result_t globus_ftp_client_debug_plugin_init

(globus_ftp_client_plugin_t * plugin, FILE * stream, const char * 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. it's giving "let her cook" 🔥

Parameters

  • plugin — A pointer to an uninitialized plugin. The plugin will be configured as a debugging plugin, with the default of sending debugging messages to stderr.
  • stream
  • text
ngl, stream and text don't get any extra explanation in the original. that's just how it is, i don't make the rules 🙈

Returns

This function returns an error if

  • plugin is null

See also

  • globus_ftp_client_debug_plugin_destroy()
  • globus_ftp_client_handleattr_add_plugin()
  • globus_ftp_client_handleattr_remove_plugin()
  • globus_ftp_client_handle_init()

👑 Author 👑

Generated automatically by Doxygen for globus_ftp_client from the source code. the robots did this one, we just made it cute 💖

okay that's the whole page bestie, you ate that 🍓✨ this was globus_ftp_client Version 9.9, from the globus_ftp...bug_plugin(3) page — mwah, go debug something iconic 💅🎀

📦 where this page comes from