globus_i_f...t_handle_t(3)

💖 globus_i_f...t_handle_t(3) 💖

okay bestie, we're in the Library Functions Manual today and this one is globus_i_f...t_handle_t — the FTP Client handle implementation, and yes it's a struct, and yes it has a lot of fields. buckle up, we're going through every single one. no skipping. 🫶

---

✨ NAME ✨

globus_i_ftp_client_handle_t — FTP Client handle implementation. that's the whole vibe. 💅

---

🌸 SYNOPSIS 🌸

#include <globus_i_ftp_client.h>

🎀 Data Fields

• char magic [24]
• globus_ftp_client_handle_t * handle
• struct globus_i_ftp_client_target_s * source
• char * source_url
• struct globus_i_ftp_client_target_s * dest
• char * dest_url
• globus_i_ftp_client_operation_t op
• globus_ftp_client_complete_callback_t callback
• void * callback_arg
• globus_ftp_client_handle_state_t state
• globus_priority_q_t stalled_blocks
• globus_hashtable_t active_blocks
• int num_active_blocks
• globus_ftp_control_host_port_t * pasv_address
• int num_pasv_addresses
• globus_object_t * err
• struct globus_i_ftp_client_restart_s * restart_info
• int notify_in_progress
• globus_off_t source_size
• globus_ftp_client_restart_marker_t restart_marker
• globus_off_t partial_offset
• globus_off_t partial_end_offset
• globus_off_t base_offset
• globus_off_t read_all_biggest_offset
• globus_abstime_t * modification_time_pointer
• globus_off_t * size_pointer
• globus_i_ftp_client_features_t * features_pointer
• globus_byte_t ** mlst_buffer_pointer
• int chmod_file_mode
• char * chgrp_group
• struct tm utime_time
• globus_mutex_t mutex
• char * checksum
• globus_off_t checksum_offset
• globus_fifo_t src_op_queue
• void * user_pointer

---

💜 Detailed Description 💜

FTP Client handle implementation. that's it, that's the description, the struct is the description, it's giving "I contain multitudes." 👑

---

🌈 Field Documentation 🌈

🦋 globus_hashtable_t globus_i_ftp_client_handle_t::active_blocks

A hash of the data blocks that the control handle is currently busy processing. it's the "currently in the group chat" list. 🔥

🦋 globus_off_t globus_i_ftp_client_handle_t::base_offset

The base offset for a transfer — and in stream mode, bestie, this gets added onto every single offset. all of them. no cap.

🦋 globus_ftp_client_complete_callback_t globus_i_ftp_client_handle_t::callback

The callback that gets called once this operation is completed. it's the "we're done here" text. 💖

🦋 void* globus_i_ftp_client_handle_t::callback_arg

The user-supplied parameter for that callback. your little gift to future-you. 🎀

🦋 char* globus_i_ftp_client_handle_t::checksum

cksm pointer. short, sweet, iconic.

🦋 globus_off_t globus_i_ftp_client_handle_t::checksum_offset

checksum parameters.

🦋 char* globus_i_ftp_client_handle_t::chgrp_group

The group name or ID for CHGRP.

🦋 int globus_i_ftp_client_handle_t::chmod_file_mode

The file mode for CHMOD.

🦋 struct globus_i_ftp_client_target_s* globus_i_ftp_client_handle_t::dest

Info about the connection to the destination URL, for a put or a third-party transfer. the "where it's going" of it all. ✨

🦋 char* globus_i_ftp_client_handle_t::dest_url

destination URL. 📍

🦋 globus_object_t* globus_i_ftp_client_handle_t::err

The error object that gets passed to the completion callback. when things go sideways, this is the one who tells the story. 😭

🦋 globus_i_ftp_client_features_t* globus_i_ftp_client_handle_t::features_pointer

Pointer to the user's features buffer.

🦋 globus_ftp_client_handle_t* globus_i_ftp_client_handle_t::handle

The user's handle pointer — the one used to initialize this very structure. the origin story. 🌱

🦋 char globus_i_ftp_client_handle_t::magic[24]

client handle magic number. ✨magical✨ literally.

🦋 globus_byte_t** globus_i_ftp_client_handle_t::mlst_buffer_pointer

Pointer to the user's MLST/STAT string buffer.

🦋 globus_abstime_t* globus_i_ftp_client_handle_t::modification_time_pointer

Pointer to the user's modification time buffer.

🦋 globus_mutex_t globus_i_ftp_client_handle_t::mutex

Thread safety. that's the whole field note. protect the vibes. 🔒

🦋 int globus_i_ftp_client_handle_t::notify_in_progress

Delayed notification information.

🦋 int globus_i_ftp_client_handle_t::num_active_blocks

How many blocks are chillin' in the active_blocks hash. 🔢

🦋 int globus_i_ftp_client_handle_t::num_pasv_addresses

How many passive addresses we know about.

🦋 globus_i_ftp_client_operation_t globus_i_ftp_client_handle_t::op

The current operation on this handle. main character energy, one op at a time. 👑

🦋 globus_off_t globus_i_ftp_client_handle_t::partial_end_offset

Partial file transfer ending offset. the "and that's where we stop" offset. 🛑

🦋 globus_off_t globus_i_ftp_client_handle_t::partial_offset

Partial file transfer starting offset. the "and that's where we begin" offset. 🚀

🦋 globus_ftp_control_host_port_t* globus_i_ftp_client_handle_t::pasv_address

Address of the PASV side of a transfer.

🦋 globus_off_t globus_i_ftp_client_handle_t::read_all_biggest_offset

The offset used to figure out what length to return in a read callback when the read_all attribute is set. it's doing math so you don't have to. 🧮

🦋 struct globus_i_ftp_client_restart_s* globus_i_ftp_client_handle_t::restart_info

Restart information.

🦋 globus_ftp_client_restart_marker_t globus_i_ftp_client_handle_t::restart_marker

Current info about what has been transferred so far. the "receipts" of the transfer, if you will. 🧾

🦋 globus_off_t* globus_i_ftp_client_handle_t::size_pointer

Pointer to the user's size buffer.

🦋 struct globus_i_ftp_client_target_s* globus_i_ftp_client_handle_t::source

Info about the connection to the source URL, for a get or a third-party transfer. the "where it's coming from" counterpart to dest. 🌸

🦋 globus_off_t globus_i_ftp_client_handle_t::source_size

The size of the file to be downloaded — if known. emphasis on if, bestie, don't come for me. 🙈

🦋 char* globus_i_ftp_client_handle_t::source_url

source URL. 📍

🦋 globus_fifo_t globus_i_ftp_client_handle_t::src_op_queue

piplining operation queue. (yes that's how it's spelled here, i'm just the messenger 🫶)

🦋 globus_priority_q_t globus_i_ftp_client_handle_t::stalled_blocks

A priority queue of the data blocks that haven't made it to the FTP control library yet. they're not lost, they're just... waiting their turn. ⏳

🦋 globus_ftp_client_handle_state_t globus_i_ftp_client_handle_t::state

The current state of the operation we're processing.

🦋 void* globus_i_ftp_client_handle_t::user_pointer

User pointer.

👀 See also: globus_ftp_client_handle_set_user_pointer(), globus_ftp_client_handle_get_user_pointer()

🦋 struct tm globus_i_ftp_client_handle_t::utime_time

The modification time for UTIME.

---

💫 Author 💫

Generated automatically by Doxygen for globus_ftp_client from the source code. not a human, not a bestie, just a robot doing its little documentation dance. 🤖💃

---

🌟 and that's a wrap 🌟

this page came from globus_ftp_client, Version 9.9, and it lives under the manual name globus_ftp_client — you found it filed as globus_i_f...t_handle_t(3). go forth and handle your FTP clients, bestie, you're literally so good at this. 💅✨🎀