globus_ftp...t_plugin.h(3)

✨ globus_ftp_client_plugin.h(3) ✨

Library Functions Manual

okay bestie, welcome to the plugin implementation page 💅 this is the header that hands you every callback typedef for plugging into the Globus FTP client. no cap, every signature is here, exactly as written. let's get into it 🫶

🌸 NAME 🌸

globus_ftp_client_plugin.h — Plugin Implementation.

🦋 SYNOPSIS 🦋

#include 'globus_ftp_client.h'

💖 Typedefs 💖

bestie, here's the full typedef wall, exactly as declared. no edits, no omissions, periodt ✨

   typedef globus_ftp_client_plugin_t *(* globus_ftp_client_plugin_copy_t)
       (globus_ftp_client_plugin_t *plugin_template, void *plugin_specific)
   typedef void(* globus_ftp_client_plugin_destroy_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific)
   typedef void(* globus_ftp_client_plugin_connect_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url)
   typedef void(* globus_ftp_client_plugin_authenticate_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const
       globus_ftp_control_auth_info_t *auth_info)
   typedef void(* globus_ftp_client_plugin_chmod_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, int mode, const
       globus_ftp_client_operationattr_t *attr, globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_chgrp_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const char
       *group, const globus_ftp_client_operationattr_t *attr, globus_bool_t
       restart)
   typedef void(* globus_ftp_client_plugin_utime_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const struct tm
       *utime_time, const globus_ftp_client_operationattr_t *attr,
       globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_symlink_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const char
       *link_url, const globus_ftp_client_operationattr_t *attr,
       globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_cksm_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, globus_off_t
       offset, globus_off_t length, const char *algorithm, const
       globus_ftp_client_operationattr_t *attr, globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_delete_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const
       globus_ftp_client_operationattr_t *attr, globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_feat_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const
       globus_ftp_client_operationattr_t *attr, globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_mkdir_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const
       globus_ftp_client_operationattr_t *attr, globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_rmdir_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const
       globus_ftp_client_operationattr_t *attr, globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_list_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const
       globus_ftp_client_operationattr_t *attr, globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_verbose_list_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const
       globus_ftp_client_operationattr_t *attr, globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_machine_list_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const
       globus_ftp_client_operationattr_t *attr, globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_recursive_list_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const
       globus_ftp_client_operationattr_t *attr, globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_mlst_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const
       globus_ftp_client_operationattr_t *attr, globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_stat_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const
       globus_ftp_client_operationattr_t *attr, globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_move_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *source_url, const
       char *dest_url, const globus_ftp_client_operationattr_t *attr,
       globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_get_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const
       globus_ftp_client_operationattr_t *attr, globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_put_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const
       globus_ftp_client_operationattr_t *attr, globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_third_party_transfer_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *source_url, const
       globus_ftp_client_operationattr_t *source_attr, const char
       *dest_url, const globus_ftp_client_operationattr_t *dest_attr,
       globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_modification_time_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const
       globus_ftp_client_operationattr_t *attr, globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_size_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const
       globus_ftp_client_operationattr_t *attr, globus_bool_t restart)
   typedef void(* globus_ftp_client_plugin_abort_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle)
   typedef void(* globus_ftp_client_plugin_read_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const globus_byte_t *buffer,
       globus_size_t buffer_length)
   typedef void(* globus_ftp_client_plugin_write_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const globus_byte_t *buffer,
       globus_size_t buffer_length, globus_off_t offset, globus_bool_t eof)
   typedef void(* globus_ftp_client_plugin_data_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, globus_object_t *error, const
       globus_byte_t *buffer, globus_size_t length, globus_off_t offset,
       globus_bool_t eof)
   typedef void(* globus_ftp_client_plugin_command_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, const char
       *command)
   typedef void(* globus_ftp_client_plugin_response_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, globus_object_t
       *error, const globus_ftp_control_response_t *ftp_response)
   typedef void(* globus_ftp_client_plugin_fault_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle, const char *url, globus_object_t
       *error)
   typedef void(* globus_ftp_client_plugin_complete_t)
       (globus_ftp_client_plugin_t *plugin, void *plugin_specific,
       globus_ftp_client_handle_t *handle)

🎀 Enumerations 🎀

and the enum, exactly as it appears:

       enum globus_ftp_client_plugin_command_mask_t {  }

✨ FUNCTIONS ✨

okay bestie, deep breath, because this is the part where we meet the whole squad 🫶 every single one of these returns a globus_result_t, so that's your lil receipt for "did it work or did it not" — and yes, we're listing all of them, no skips, no "lol you get the idea". iykyk 💅

Most of the restart crew take the exact same four things: a handle, a url, an attr, and a when. Once you clock that pattern, the rest is just vibes. 🌈

---

• globus_ftp_client_plugin_restart_list

globus_result_t globus_ftp_client_plugin_restart_list (globus_ftp_client_handle_t *handle, const char *url, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

the classic. handle, url, attr, when. iconic, no notes ✨

• globus_ftp_client_plugin_restart_verbose_list

globus_result_t globus_ftp_client_plugin_restart_verbose_list (globus_ftp_client_handle_t *handle, const char *url, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

same four, just the verbose one. it's giving "tell me everything" 🎀

• globus_ftp_client_plugin_restart_machine_list

globus_result_t globus_ftp_client_plugin_restart_machine_list (globus_ftp_client_handle_t *handle, const char *url, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

same shape again — handle, url, attr, when. 💜

• globus_ftp_client_plugin_restart_recursive_list

globus_result_t globus_ftp_client_plugin_restart_recursive_list (globus_ftp_client_handle_t *handle, const char *url, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

yes, still the same four. consistency is lowkey the main character here 👑

• globus_ftp_client_plugin_restart_mlst

globus_result_t globus_ftp_client_plugin_restart_mlst (globus_ftp_client_handle_t *handle, const char *url, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

handle, url, attr, when. fr fr, that's the whole thing. 🦋

• globus_ftp_client_plugin_restart_stat

globus_result_t globus_ftp_client_plugin_restart_stat (globus_ftp_client_handle_t *handle, const char *url, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

four params, one dream. 💖

• globus_ftp_client_plugin_restart_delete

globus_result_t globus_ftp_client_plugin_restart_delete (globus_ftp_client_handle_t *handle, const char *url, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

yep — handle, url, attr, when. 💀 (respectfully)

• globus_ftp_client_plugin_restart_chmod

globus_result_t globus_ftp_client_plugin_restart_chmod (globus_ftp_client_handle_t *handle, const char *url, int mode, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

okay this one got a little extra ✨ there's an int mode wedged in there between url and attr. five things now, bestie, we love growth.

• globus_ftp_client_plugin_restart_chgrp

globus_result_t globus_ftp_client_plugin_restart_chgrp (globus_ftp_client_handle_t *handle, const char *url, const char *group, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

and here it's a const char *group doing the extra credit. 🌸

• globus_ftp_client_plugin_restart_utime

globus_result_t globus_ftp_client_plugin_restart_utime (globus_ftp_client_handle_t *handle, const char *url, const struct tm *utime_time, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

this one brings a whole const struct tm *utime_time to the function. fancy. ⭐

• globus_ftp_client_plugin_restart_symlink

globus_result_t globus_ftp_client_plugin_restart_symlink (globus_ftp_client_handle_t *handle, const char *url, const char *link_url, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

url and link_url both in the building. two urls, zero drama. 🧚

• globus_ftp_client_plugin_restart_cksm

globus_result_t globus_ftp_client_plugin_restart_cksm (globus_ftp_client_handle_t *handle, const char *url, globus_off_t offset, globus_off_t length, const char *algorithm, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

look at her go 😭 handle, url, globus_off_t offset, globus_off_t length, const char *algorithm, attr, when. that's SEVEN. she ate and left no crumbs.

• globus_ftp_client_plugin_restart_feat

globus_result_t globus_ftp_client_plugin_restart_feat (globus_ftp_client_handle_t *handle, const char *url, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

back to the classic four. we love a return to form 🫶

• globus_ftp_client_plugin_restart_mkdir

globus_result_t globus_ftp_client_plugin_restart_mkdir (globus_ftp_client_handle_t *handle, const char *url, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

handle, url, attr, when. manifesting directories ✨

• globus_ftp_client_plugin_restart_rmdir

globus_result_t globus_ftp_client_plugin_restart_rmdir (globus_ftp_client_handle_t *handle, const char *url, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

same four, opposite energy. balance 💜

• globus_ftp_client_plugin_restart_move

globus_result_t globus_ftp_client_plugin_restart_move (globus_ftp_client_handle_t *handle, const char *source_url, const char *dest_url, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

no url here bestie, it's source_url AND dest_url. she's got range. 🔥

• globus_ftp_client_plugin_restart_get

globus_result_t globus_ftp_client_plugin_restart_get (globus_ftp_client_handle_t *handle, const char *url, const globus_ftp_client_operationattr_t *attr, globus_ftp_client_restart_marker_t *restart_marker, const globus_abstime_t *when)

now we're talking. handle, url, attr, then a globus_ftp_client_restart_marker_t *restart_marker, then when. 🎀

• globus_ftp_client_plugin_restart_put

globus_result_t globus_ftp_client_plugin_restart_put (globus_ftp_client_handle_t *handle, const char *url, const globus_ftp_client_operationattr_t *attr, globus_ftp_client_restart_marker_t *restart_marker, const globus_abstime_t *when)

same five as get, just the other direction. mirror selfie energy 🪞✨

• globus_ftp_client_plugin_restart_third_party_transfer

globus_result_t globus_ftp_client_plugin_restart_third_party_transfer (globus_ftp_client_handle_t *handle, const char *source_url, const globus_ftp_client_operationattr_t *source_attr, const char *dest_url, const globus_ftp_client_operationattr_t *dest_attr, globus_ftp_client_restart_marker_t *restart_marker, const globus_abstime_t *when)

THE maximalist of the group 😭 handle, source_url, source_attr, dest_url, dest_attr, restart_marker, when. seven params and every one of them is doing something. she's the moment. 👑

• globus_ftp_client_plugin_restart_size

globus_result_t globus_ftp_client_plugin_restart_size (globus_ftp_client_handle_t *handle, const char *url, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

classic four. we're so back. 🌈

• globus_ftp_client_plugin_restart_modification_time

globus_result_t globus_ftp_client_plugin_restart_modification_time (globus_ftp_client_handle_t *handle, const char *url, const globus_ftp_client_operationattr_t *attr, const globus_abstime_t *when)

yep, handle, url, attr, when. 💖

• globus_ftp_client_plugin_restart_get_marker

globus_result_t globus_ftp_client_plugin_restart_get_marker (globus_ftp_client_handle_t *handle, globus_ftp_client_restart_marker_t *marker)

ooh, this one's a rebel — just handle and a globus_ftp_client_restart_marker_t *marker. no url, no attr, no when. she said "i'll go alone" 💅

• globus_ftp_client_plugin_abort

globus_result_t globus_ftp_client_plugin_abort (globus_ftp_client_handle_t *handle)

one param. just the handle. minimalism, but make it ✨

• globus_ftp_client_plugin_add_data_channels

globus_result_t globus_ftp_client_plugin_add_data_channels (globus_ftp_client_handle_t *handle, unsigned int num_channels, unsigned int stripe)

handle, unsigned int num_channels, unsigned int stripe. two lil unsigned ints, out here living their best lives. 🔥

• globus_ftp_client_plugin_remove_data_channels

globus_result_t globus_ftp_client_plugin_remove_data_channels (globus_ftp_client_handle_t *handle, unsigned int num_channels, unsigned int stripe)

exact same trio as add, just the opposite vibe. add her, remove her, it's a cycle 🦋

---

💖 DETAILED DESCRIPTION 💖

Plugin Implementation.

that's the whole thing bestie, that's what this page is about — Plugin Implementation. short, sweet, straight to the point. 🎀

---

🌸 AUTHOR 🌸

Generated automatically by Doxygen for globus_ftp_client from the source code.

not a human author, just the machine doing its lil automatic thing 🧚

---

okay that's the whole page babes, we made it 🫶 you now know every single function in globus_ftp...t_plugin.h(3) — this came from globus_ftp_client, Version 9.9, and that globus_ftp...t_plugin.h(3) up in the corner is just the page name being cute and abbreviated. go forth and plug in those plugins, no cap 💖✨🎀