.TH "globus_ftp_client.h" 3 "Wed Feb 27 2019" "Version 9.2" "globus_ftp_client" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_ftp_client.h \- GridFTP Client\&.  

.SH SYNOPSIS
.br
.PP
\fC#include 'globus_ftp_control\&.h'\fP
.br
\fC#include 'globus_priority_q\&.h'\fP
.br

.SS "Data Structures"

.in +1c
.ti -1c
.RI "struct \fBglobus_ftp_client_restart_stream_t\fP"
.br
.RI "Stream mode restart marker\&. "
.ti -1c
.RI "struct \fBglobus_ftp_client_restart_extended_block_t\fP"
.br
.RI "Extended block mode restart marker\&. "
.ti -1c
.RI "union \fBglobus_ftp_client_restart_marker_t\fP"
.br
.RI "Restart marker\&.
.PP
This structure is may be either a stream mode transfer offset, or an extended block mode byte range\&. "
.in -1c
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_FTP_CLIENT_MODULE\fP"
.br
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef struct \fBglobus_i_ftp_client_handle_t\fP * \fBglobus_ftp_client_handle_t\fP"
.br
.RI "FTP Client Handle\&.
.PP
An FTP client handle is used to associate state with a group of operations\&. Handles can have \fBattributes\fP associated with them\&. All FTP \fBoperations \fP take a handle pointer as a parameter\&. "
.ti -1c
.RI "typedef struct \fBglobus_i_ftp_client_plugin_t\fP * \fBglobus_ftp_client_plugin_t\fP"
.br
.RI "FTP Client plugin
.PP
An FTP Client plugin is used to add restart, monitoring, and performance tuning operations to the FTP Client library, without modifying the base API\&. Multiple plugins may be associated with a globus_ftp_client_handle_t\&. "
.ti -1c
.RI "typedef void(* \fBglobus_ftp_client_complete_callback_t\fP) (void *user_arg, \fBglobus_ftp_client_handle_t\fP *handle, globus_object_t *error)"
.br
.ti -1c
.RI "typedef void(* \fBglobus_ftp_client_data_callback_t\fP) (void *user_arg, \fBglobus_ftp_client_handle_t\fP *handle, globus_object_t *error, globus_byte_t *buffer, globus_size_t length, globus_off_t offset, globus_bool_t eof)"
.br
.ti -1c
.RI "typedef struct \fBglobus_i_ftp_client_operationattr_t\fP * \fBglobus_ftp_client_operationattr_t\fP"
.br
.RI "Operation Attributes\&.
.PP
FTP Client attributes are used to control the parameters needed to access an URL using the FTP protocol\&. Attributes are created and manipulated using the functions in the \fBattributes \fP section of the library\&. "
.ti -1c
.RI "typedef struct \fBglobus_i_ftp_client_handleattr_t\fP * \fBglobus_ftp_client_handleattr_t\fP"
.br
.RI "Handle Attributes\&.
.PP
Handle attributes are used to control the caching behavior of the ftp client handle, and to implement the plugin features for reliability and performance tuning\&. "
.ti -1c
.RI "typedef struct \fBglobus_i_ftp_client_features_s\fP * \fBglobus_ftp_client_features_t\fP"
.br
.RI "Feature Handle
.PP
Handle used to associate state with feature operations\&. "
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBglobus_ftp_client_error_t\fP "
.br
.ti -1c
.RI "enum \fBglobus_ftp_client_restart_type_t\fP "
.br
.ti -1c
.RI "enum \fBglobus_ftp_client_tristate_t\fP "
.br
.ti -1c
.RI "enum \fBglobus_ftp_client_probed_feature_t\fP "
.br
.in -1c
.SS "Variables"

.in +1c
.ti -1c
.RI "globus_module_descriptor_t \fBglobus_i_ftp_client_module\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
GridFTP Client\&. 


.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBglobus_ftp_client_error_t\fP"
Error types 
.SS "enum \fBglobus_ftp_client_restart_type_t\fP"
Restart marker types\&. 
.SH "Variable Documentation"
.PP 
.SS "globus_module_descriptor_t globus_i_ftp_client_module"
Module descriptor static initializer\&. 
.SH "Author"
.PP 
Generated automatically by Doxygen for globus_ftp_client from the source code\&.