globus_ftp...art_plugin(3)

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

💅 NAME 💅

globus_ftp_client_restart_plugin — the Restart Plugin, bestie. That's it, that's the name.

✨ SYNOPSIS ✨

🎀 Macros

#define GLOBUS_FTP_CLIENT_RESTART_PLUGIN_MODULE
    (&globus_i_ftp_client_restart_plugin_module)

🦋 Functions

globus_result_t globus_ftp_client_restart_plugin_init
    (globus_ftp_client_plugin_t *plugin, int max_retries,
    globus_reltime_t *interval, globus_abstime_t *deadline)

globus_result_t globus_ftp_client_restart_plugin_destroy
    (globus_ftp_client_plugin_t *plugin)

🌸 Detailed Description 🌸

Restart Plugin. Okay so, the whole vibe here:

The restart plugin implements one scheme for providing reliability functionality for the FTP Client library. Other plugins may be developed to provide other methods of reliability — like, this is not the only way, it's just a way, and honestly it ate.

The specific functionality of this plugin is to restart any FTP operation when a fault occurs. Its operation is parameterized so you can control how often and when it attempts to restart the operation. Very "I got you, hold on, let me try again" energy.

This restart plugin will restart an FTP operation if a noticeable fault has occurred — a connection timing out, a failure by the server to process a command, a protocol error, an authentication error. Basically any time the operation trips, this plugin catches it and gets it back up. 🫶

This plugin has three user-configurable parameters; these are:

  1. the maximum number of retries to attempt
  2. the interval to wait between retries
  3. the deadline after which no further retries will be attempted

These are set by initializing a restart plugin instance with the function globus_ftp_client_restart_plugin_init(). No cap. 💖

🧚 Macro Definition Documentation 🧚

#define GLOBUS_FTP_CLIENT_RESTART_PLUGIN_MODULE

(&globus_i_ftp_client_restart_plugin_module)

Module descriptor, periodt. That's all she is, and she's iconic for it. ⭐

🔥 Function Documentation 🔥

globus_result_t globus_ftp_client_restart_plugin_destroy (globus_ftp_client_plugin_t * plugin)

Destroy an instance of the GridFTP restart plugin. 💀 Okay so this one's the breakup text:

This function will free all restart plugin-specific instance data from this plugin, and will make the plugin unusable for further ftp handle creation. She's done, she's retired, she's not coming back for another round.

Important bestie note: 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. So like, you already cloned her before the goodbye, she lives on in there. 🦋

Parameters

  • plugin — A pointer to a GridFTP restart plugin, previously initialized by calling globus_ftp_client_restart_plugin_init()

Returns

This function returns an error if:

  • plugin is null
  • plugin is not a restart plugin

See also

  • globus_ftp_client_restart_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_restart_plugin_init (globus_ftp_client_plugin_t * plugin, int max_retries, globus_reltime_t * interval, globus_abstime_t * deadline)

Initialize an instance of the GridFTP restart plugin. ✨ The glow-up moment:

This function will initialize the plugin-specific instance data for this plugin, and will make the plugin usable for ftp client handle attribute and handle creation. She's ready, she's set up, she's about to be added to a handle bestie.

Parameters

  • plugin — A pointer to an uninitialized plugin. The plugin will be configured as a restart plugin.
  • max_retries — The maximum number of times to retry the operation before giving up on the transfer. If this value is less than or equal to 0, then the restart plugin will keep trying to restart the operation until it completes or the deadline is reached with an unsuccessful operation. (So 0 or negative = stubborn mode, she does not give up, lowkey scary but slay.)
  • interval — The interval to wait after a failures before retrying the transfer. If the interval is 0 seconds or GLOBUS_NULL, then an exponential backoff will be used. 🌀
  • deadline — An absolute timeout. If the deadline is GLOBUS_NULL then the retry will never timeout. Fr fr, never. 👑

Returns

This function returns an error if:

  • plugin is null

See also

  • globus_ftp_client_restart_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. Not a human, just a very diligent little robot doing its thing. 🎀

And that's the whole page, bestie! This one's from globus_ftp_client, Version 9.9, and it's the globus_ftp...art_plugin(3) manual — go forth and restart your FTP operations with main character energy. 💖✨🦋🌸💅🫶

📦 where this page comes from