--- name: "globus_i_ftp_client_handle_t" section: "3" platform: "linux" package: "libglobus-ftp-client-doc" version: "9.8-4" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/globus_i_ftp_client_handle_t" --- # globus\_i\_ftp\_client\_handle\_t(3) FTP Client handle implementation. ## NAME globus\_i\_ftp\_client\_handle\_t - FTP Client handle implementation. ## SYNOPSIS `#include ` ### 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. ## Field Documentation ### globus\_hashtable\_t globus\_i\_ftp\_client\_handle\_t::active\_blocks Hash of data blocks which are currently being processed by the control handle. ### globus\_off\_t globus\_i\_ftp\_client\_handle\_t::base\_offset Base offset for a transfer, to be added to all offsets in stream mode ### globus\_ftp\_client\_complete\_callback\_t globus\_i\_ftp\_client\_handle\_t::callback Callback to be called once this operation is completed. ### void\* globus\_i\_ftp\_client\_handle\_t::callback\_arg User-supplied parameter to this callback ### char\* globus\_i\_ftp\_client\_handle\_t::checksum cksm pointer ### globus\_off\_t globus\_i\_ftp\_client\_handle\_t::checksum\_offset checksum parameters ### char\* globus\_i\_ftp\_client\_handle\_t::chgrp\_group group name or ID for CHGRP ### int globus\_i\_ftp\_client\_handle\_t::chmod\_file\_mode file mode for CHMOD ### struct globus\_i\_ftp\_client\_target\_s\* globus\_i\_ftp\_client\_handle\_t::dest Information about the connection to the destination URL for a put or third-party transfer. ### char\* globus\_i\_ftp\_client\_handle\_t::dest\_url destination URL ### globus\_object\_t\* globus\_i\_ftp\_client\_handle\_t::err Error object to pass to the completion callback ### globus\_i\_ftp\_client\_features\_t\* globus\_i\_ftp\_client\_handle\_t::features\_pointer Pointer to user's features buffer ### globus\_ftp\_client\_handle\_t\* globus\_i\_ftp\_client\_handle\_t::handle The user's handle pointer used to initialize this structure ### char globus\_i\_ftp\_client\_handle\_t::magic\[24\] client handle magic number ### globus\_byte\_t\*\* globus\_i\_ftp\_client\_handle\_t::mlst\_buffer\_pointer Pointer to user's MLST/STAT string buffer ### globus\_abstime\_t\* globus\_i\_ftp\_client\_handle\_t::modification\_time\_pointer Pointer to user's modification time buffer ### globus\_mutex\_t globus\_i\_ftp\_client\_handle\_t::mutex Thread safety ### int globus\_i\_ftp\_client\_handle\_t::notify\_in\_progress Delayed notification information. ### int globus\_i\_ftp\_client\_handle\_t::num\_active\_blocks Number of blocks in the active\_blocks hash. ### int globus\_i\_ftp\_client\_handle\_t::num\_pasv\_addresses Number of passive addresses we know about. ### globus\_i\_ftp\_client\_operation\_t globus\_i\_ftp\_client\_handle\_t::op Current operation on this handle ### globus\_off\_t globus\_i\_ftp\_client\_handle\_t::partial\_end\_offset Partial file transfer ending offset. ### globus\_off\_t globus\_i\_ftp\_client\_handle\_t::partial\_offset Partial file transfer starting offset. ### globus\_ftp\_control\_host\_port\_t\* globus\_i\_ftp\_client\_handle\_t::pasv\_address Address of PASV side of a transfer. ### globus\_off\_t globus\_i\_ftp\_client\_handle\_t::read\_all\_biggest\_offset Offset used to determine what length to return in a read callback in when the read\_all attribute is set. ### 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 information about what has been transferred so far. ### globus\_off\_t\* globus\_i\_ftp\_client\_handle\_t::size\_pointer Pointer to user's size buffer ### struct globus\_i\_ftp\_client\_target\_s\* globus\_i\_ftp\_client\_handle\_t::source Information about the connection to the source URL for a get or third-party transfer. ### globus\_off\_t globus\_i\_ftp\_client\_handle\_t::source\_size Size of the file to be downloaded, if known. ### 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 ### globus\_priority\_q\_t globus\_i\_ftp\_client\_handle\_t::stalled\_blocks Priority queue of data blocks which haven't yet been sent to the FTP control library ### globus\_ftp\_client\_handle\_state\_t globus\_i\_ftp\_client\_handle\_t::state Current state of the operation we are 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 modification time for UTIME ## Author Generated automatically by Doxygen for globus\_ftp\_client from the source code.