globus_i_f...t_plugin_t(3)

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

💖 NAME 💖

globus_i_ftp_client_plugin_t — the FTP Client Plugin. that's her. that's the whole vibe. 🦋

✨ SYNOPSIS ✨

#include <globus_i_ftp_client.h>

🎀 Data Fields 🎀

  • char * plugin_name
  • globus_ftp_client_plugin_t * plugin
  • globus_ftp_client_plugin_copy_t copy_func
  • globus_ftp_client_plugin_destroy_t destroy_func
  • globus_ftp_client_plugin_command_mask_t command_mask
  • void * plugin_specific

🌸 Detailed Description 🌸

okay bestie, so this is the FTP Client Plugin. it's giving "struct with main character energy" fr fr.

every single plugin implementation is supposed to define its own method for initializing one of these structures. like, that's the assignment. and plugins can be built either as a static function table or as a specialized plugin with plugin-specific attributes — both are valid, no gatekeeping here. 💅

and here's the tea about every plugin function: it can be either GLOBUS_NULL or a valid function pointer. that's it, those are the options. if the function is GLOBUS_NULL, then the plugin will not be notified when the corresponding event happens. she's simply not on the invite list for that one. 🙈

👑 Field Documentation 👑

globus_ftp_client_plugin_command_mask_t

globus_i_ftp_client_plugin_t::command_mask

Command Mask ✨

the bits that are set in this mask decide which command responses the plugin is interested in. like, what she's actually paying attention to. the command_mask should be a bitwise-or of the values in the globus_ftp_client_plugin_command_mask_t enumeration. periodt.

globus_ftp_client_plugin_copy_t globus_i_ftp_client_plugin_t::copy_func

Plugin function pointers. 🫶

globus_ftp_client_plugin_destroy_t

globus_i_ftp_client_plugin_t::destroy_func

Plugin function pointers. 🫶

globus_ftp_client_plugin_t* globus_i_ftp_client_plugin_t::plugin

the value the user/plugin implementation passed into the plugin handling parts of the API. basically: whatever they handed over, this is where it lives now. 💜

char* globus_i_ftp_client_plugin_t::plugin_name

Plugin name. 🎀

the plugin name is what the FTP Client library uses to detect multiple instances of the same plugin being associated with a globus_ftp_client_handleattr_t or globus_ftp_client_handle_t. yes, she's doing surveillance. for your own good. 💀

each plugin type should have a unique plugin name, and that name must be a NULL-terminated string of arbitrary length. arbitrary length!! go off, honestly. 🌈

void* globus_i_ftp_client_plugin_t::plugin_specific

this pointer is reserved for plugin-specific data. it's her private little stash, don't touch. 🍓

🧚 Author 🧚

Generated automatically by Doxygen for globus_ftp_client from the source code. not a human, just vibes and parsing. 😭

and that's the page, bestie! this came to you from globus_ftp_client, Version 9.9, in the Library Functions Manual. thanks for reading all the way to the bottom, you're literally the icon of this whole doc. slay. 💖✨👑
📦 where this page comes from