GLOBUS_FTP_CLIENT_PERF_PLUGIN_USER_COPY_CB_T(3)

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

💖 globus_ftp_client_perf_plugin 💖

okay bestie, welcome to the Library Functions Manual for globus_ftp_client_perf_plugin — this is the Performance Marker Plugin and she is lowkey a whole vibe. Let's get into it. ✨

✨ NAME ✨

globus_ftp_client_perf_plugin — Performance Marker Plugin.

Performance Marker Plugin. 💅

✨ SYNOPSIS ✨

Macros 🌸

#define GLOBUS_FTP_CLIENT_PERF_PLUGIN_MODULE
    (&globus_i_ftp_client_perf_plugin_module)

Typedefs 🎀

typedef void(* globus_ftp_client_perf_plugin_begin_cb_t) (void
    *user_specific, globus_ftp_client_handle_t *handle, const char
    *source_url, const char *dest_url, globus_bool_t restart)
typedef void(* globus_ftp_client_perf_plugin_marker_cb_t) (void
    *user_specific, globus_ftp_client_handle_t *handle, time_t
    time_stamp_int, char time_stamp_tenth, int stripe_ndx, int
    num_stripes, globus_off_t nbytes)
typedef void(* globus_ftp_client_perf_plugin_complete_cb_t) (void
    *user_specific, globus_ftp_client_handle_t *handle, globus_bool_t
    success)
typedef void *(* globus_ftp_client_perf_plugin_user_copy_cb_t) (void
    *user_specific)
typedef void(* globus_ftp_client_perf_plugin_user_destroy_cb_t) (void
    *user_specific)

Functions 🦋

globus_result_t globus_ftp_client_perf_plugin_init
    (globus_ftp_client_plugin_t *plugin,
    globus_ftp_client_perf_plugin_begin_cb_t begin_cb,
    globus_ftp_client_perf_plugin_marker_cb_t marker_cb,
    globus_ftp_client_perf_plugin_complete_cb_t complete_cb, void
    *user_specific)
globus_result_t globus_ftp_client_perf_plugin_set_copy_destroy
    (globus_ftp_client_plugin_t *plugin,
    globus_ftp_client_perf_plugin_user_copy_cb_t copy_cb,
    globus_ftp_client_perf_plugin_user_destroy_cb_t destroy_cb)
globus_result_t globus_ftp_client_perf_plugin_destroy
    (globus_ftp_client_plugin_t *plugin)
globus_result_t globus_ftp_client_perf_plugin_get_user_specific
    (globus_ftp_client_plugin_t *plugin, void **user_specific)

✨ Detailed Description ✨

Performance Marker Plugin. 🫶

So here's the tea: the FTP Performance Marker plugin lets you (the user, the main character) obtain performance markers for all types of transfers — except a third party transfer where Extended Block mode is not enabled. She's picky like that, and honestly? Valid. 💅

These markers can be generated internally, or they can be received from a server (put or third_party_transfer only, iykyk). ✨

There are also copy constructor and destructor callbacks provided, so you can more easily layer other plugins on top of this one. Stacking plugins? It's giving lewk. 👑

✨ Macro Definition Documentation ✨

#define GLOBUS_FTP_CLIENT_PERF_PLUGIN_MODULE

(&globus_i_ftp_client_perf_plugin_module)

Module descriptor. 💖

✨ Typedef Documentation ✨

typedef void(* globus_ftp_client_perf_plugin_begin_cb_t) (void *user_specific, globus_ftp_client_handle_t *handle, const char *source_url, const char *dest_url, globus_bool_t restart)

Transfer begin callback 🌸

This callback fires when a get, put, or third party transfer gets started. Heads up though — it is possible for this callback to be made multiple times before you ever receive the complete callback… which is exactly what happens if a transfer got restarted. The restart value will tell you whether or not we have been restarted. No cap. 🔥

Parameters

  • handle — this the client handle that this transfer will be occurring on
  • user_specific — this is user specific data either created by the copy method, or, if a copy method was not specified, the value passed to init
  • source_url — source of the transfer (GLOBUS_NULL if put)
  • dest_url — dest of the transfer (GLOBUS_NULL if get)
  • restart — boolean indicating whether this callback is result of a restart

Returns

  • n/a

typedef void(* globus_ftp_client_perf_plugin_complete_cb_t) (void *user_specific, globus_ftp_client_handle_t *handle, globus_bool_t success)

Transfer complete callback ✅

This callback will be called upon transfer completion — successful or otherwise, bestie. Either way we're showing up. 😭

Parameters

  • handle — this the client handle that this transfer was occurring on
  • user_specific — this is user specific data either created by the copy method, or, if a copy method was not specified, the value passed to init
  • success — indicates whether this transfer completed successfully or was interrupted (by error or abort)

Returns

  • n/a

typedef void(* globus_ftp_client_perf_plugin_marker_cb_t) (void *user_specific, globus_ftp_client_handle_t *handle, time_t time_stamp_int, char time_stamp_tenth, int stripe_ndx, int num_stripes, globus_off_t nbytes)

Performance marker received callback 📊

This callback gets called for all types of transfers — except a third party one in which extended block mode is not used (because 112 perf markers won't be sent in that case, and she simply cannot work with that 💀). For extended mode put and 3pt, actual 112 perf markers will be used, and the frequency of this callback is dependent upon the frequency those messages are received. For put where extended block mode is not enabled, and for get transfers, the information in this callback will be determined locally, and the frequency of this callback will be at a maximum of one per second.

Parameters

  • handle — this the client handle that this transfer is occurring on
  • user_specific — this is user specific data either created by the copy method, or, if a copy method was not specified, the value passed to init
  • time_stamp_int — the timestamp at which the number of bytes is valid (integer part)
  • time_stamp_tenth — the timestamp at which the number of bytes is valid (tenth part)
  • stripe_ndx — the stripe index this data refers to
  • num_stripes — total number of stripes involved in this transfer
  • nbytes — the total bytes transferred on this stripe

Returns

  • n/a

typedef void *(* globus_ftp_client_perf_plugin_user_copy_cb_t) (void *user_specific)

Copy constructor 🧚

This callback will be called when a copy of this plugin is made. It's intended to allow initialization of a new user_specific data. Fresh start, new you. ✨

Parameters

  • user_specific — this is user specific data either created by this copy method, or the value passed to init

Returns

  • a pointer to a user specific piece of data
  • GLOBUS_NULL (does not indicate error)

typedef void(* globus_ftp_client_perf_plugin_user_destroy_cb_t) (void *user_specific)

Destructor 💀

This callback will be called when a copy of this plugin is destroyed. It's intended to allow the user to free up any memory associated with the user specific data. Cleanup era. 🧹

Parameters

  • user_specific — this is user specific data created by the copy method

Returns

  • n/a

✨ Function Documentation ✨

globus_result_t globus_ftp_client_perf_plugin_destroy (globus_ftp_client_plugin_t * plugin)

Destroy performance marker plugin 🔥

Frees up memory associated with plugin. Let her go, bestie.

Parameters

  • plugin — plugin previously initialized with init (above)

Returns

  • GLOBUS_SUCCESS
  • Error on NULL plugin

globus_result_t globus_ftp_client_perf_plugin_get_user_specific (globus_ftp_client_plugin_t * plugin, void ** user_specific)

Retrieve user specific pointer 🔍

Parameters

  • plugin — plugin previously initialized with init (above)
  • user_specific — pointer to storage for user_specific pointer

Returns

  • GLOBUS_SUCCESS
  • Error on NULL plugin
  • Error on NULL user_specific

globus_result_t globus_ftp_client_perf_plugin_init (globus_ftp_client_plugin_t * plugin, globus_ftp_client_perf_plugin_begin_cb_t begin_cb, globus_ftp_client_perf_plugin_marker_cb_t marker_cb, globus_ftp_client_perf_plugin_complete_cb_t complete_cb, void * user_specific)

Initialize a perf plugin 🌈

This function initializes a performance marker plugin. Any params except for the plugin may be GLOBUS_NULL. Yes queen, be flexible.

Parameters

  • plugin — a pointer to a plugin type to be initialized
  • user_specific — a pointer to some user specific data that will be provided to all callbacks
  • begin_cb — the callback to be called upon the start of a transfer
  • marker_cb — the callback to be called with every performance marker received
  • complete_cb — the callback to be called to indicate transfer completion

Returns

  • GLOBUS_SUCCESS
  • Error on NULL plugin
  • Error on init internal plugin

globus_result_t globus_ftp_client_perf_plugin_set_copy_destroy (globus_ftp_client_plugin_t * plugin, globus_ftp_client_perf_plugin_user_copy_cb_t copy_cb, globus_ftp_client_perf_plugin_user_destroy_cb_t destroy_cb)

Set user copy and destroy callbacks 🎀

Use this to have the plugin make callbacks any time a copy of this plugin is being made. This will allow the user to keep state for different handles. Multi-handle multitasking? We love to see it. 👑

Parameters

  • plugin — plugin previously initialized with init (above)
  • copy_cb — func to be called when a copy is needed
  • destroy_cb — func to be called when a copy is to be destroyed

Returns

  • Error on NULL arguments
  • GLOBUS_SUCCESS

✨ Author ✨

Generated automatically by Doxygen for globus_ftp_client from the source code. 🤖✨

and that's the whole page, bestie!! 🌸🦋💖 This was globus_ftp_client, Version 9.9, and the page was globus_ftp...perf_plugin(3) — no notes, she ate, periodt. 💅✨🎀

📦 where this page comes from