.TH "globus_xio_gridftp_driver.h" 3 "Version 3.6" "globus_xio_gridftp_driver" \" -*- nroff -*- .ad l .nh .SH NAME globus_xio_gridftp_driver.h \- XIO GRIDFTP Client Driver\&. .SH SYNOPSIS .br .PP \fC#include 'globus_xio_system\&.h'\fP .br \fC#include 'globus_common\&.h'\fP .br .SS "Typedefs" .in +1c .ti -1c .RI "typedef enum \fBglobus_l_xio_gridftp_mode_e\fP \fBglobus_l_xio_gridftp_mode_t\fP" .br .in -1c .SS "Enumerations" .in +1c .ti -1c .RI "enum \fBglobus_xio_gridftp_error_type_t\fP { \fBGLOBUS_XIO_GRIDFTP_ERROR_ATTR\fP, \fBGLOBUS_XIO_GRIDFTP_ERROR_SEEK\fP, \fBGLOBUS_XIO_GRIDFTP_ERROR_OUTSTANDING_READ\fP, \fBGLOBUS_XIO_GRIDFTP_ERROR_OUTSTANDING_WRITE\fP, \fBGLOBUS_XIO_GRIDFTP_ERROR_PENDING_READ\fP, \fBGLOBUS_XIO_GRIDFTP_ERROR_PENDING_WRITE\fP, \fBGLOBUS_XIO_GRIDFTP_ERROR_OUTSTANDING_PARTIAL_XFER\fP }" .br .ti -1c .RI "enum \fBglobus_xio_gridftp_cmd_t\fP { \fBGLOBUS_XIO_GRIDFTP_SEEK\fP, \fBGLOBUS_XIO_GRIDFTP_SET_HANDLE\fP, \fBGLOBUS_XIO_GRIDFTP_GET_HANDLE\fP, \fBGLOBUS_XIO_GRIDFTP_SET_APPEND\fP, \fBGLOBUS_XIO_GRIDFTP_GET_APPEND\fP, \fBGLOBUS_XIO_GRIDFTP_SET_ERET\fP, \fBGLOBUS_XIO_GRIDFTP_GET_ERET\fP, \fBGLOBUS_XIO_GRIDFTP_SET_ESTO\fP, \fBGLOBUS_XIO_GRIDFTP_GET_ESTO\fP, \fBGLOBUS_XIO_GRIDFTP_SET_PARTIAL_TRANSFER\fP, \fBGLOBUS_XIO_GRIDFTP_GET_PARTIAL_TRANSFER\fP, \fBGLOBUS_XIO_GRIDFTP_SET_NUM_STREAMS\fP, \fBGLOBUS_XIO_GRIDFTP_GET_NUM_STREAMS\fP, \fBGLOBUS_XIO_GRIDFTP_SET_TCP_BUFFER\fP, \fBGLOBUS_XIO_GRIDFTP_GET_TCP_BUFFER\fP, \fBGLOBUS_XIO_GRIDFTP_SET_MODE\fP, \fBGLOBUS_XIO_GRIDFTP_GET_MODE\fP, \fBGLOBUS_XIO_GRIDFTP_SET_AUTH\fP, \fBGLOBUS_XIO_GRIDFTP_GET_AUTH\fP, \fBGLOBUS_XIO_GRIDFTP_SET_DCAU\fP, \fBGLOBUS_XIO_GRIDFTP_GET_DCAU\fP, \fBGLOBUS_XIO_GRIDFTP_SET_DATA_PROTECTION\fP, \fBGLOBUS_XIO_GRIDFTP_GET_DATA_PROTECTION\fP, \fBGLOBUS_XIO_GRIDFTP_SET_CONTROL_PROTECTION\fP, \fBGLOBUS_XIO_GRIDFTP_GET_CONTROL_PROTECTION\fP }" .br .ti -1c .RI "enum \fBglobus_l_xio_gridftp_mode_e\fP " .br .in -1c .SS "Functions" .in +1c .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_handle_cntl\fP (handle, driver, \fBGLOBUS_XIO_GRIDFTP_SEEK\fP, globus_off_t seek_offset)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_HANDLE\fP, globus_ftp_client_handle_t *ftp_handle)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_HANDLE\fP, globus_ftp_client_handle_t **ftp_handle_out)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_APPEND\fP, globus_bool_t append)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_APPEND\fP, globus_bool_t *append_out)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_ERET\fP, const char *eret_alg_str)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_ERET\fP, char **eret_alg_str_out)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_ESTO\fP, const char *esto_alg_str)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_ESTO\fP, char **esto_alg_str_out)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_PARTIAL_TRANSFER\fP, globus_bool_t partial_xfer)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_PARTIAL_TRANSFER\fP, globus_bool_t *partial_xfer_out)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_NUM_STREAMS\fP, int num_streams)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_NUM_STREAMS\fP, int *num_streams_out)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_TCP_BUFFER\fP, int buf_size)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_TCP_BUFFER\fP, int *buf_size_out)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_MODE\fP, int mode)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_MODE\fP, int *mode_out)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_AUTH\fP, gss_cred_id_t credential, const char *user, const char *password, const char *account, const char *subject)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_AUTH\fP, gss_cred_id_t *credential_out, const char **user_out, const char **password_out, const char **account_out, const char **subject_out)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_DCAU\fP, int dcau_mode)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_DCAU\fP, int *dcau_mode_out)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_DATA_PROTECTION\fP, int protection)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_DATA_PROTECTION\fP, int *protection_out)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_CONTROL_PROTECTION\fP, int protection)" .br .ti -1c .RI "globus_result_t \fBglobus_xio_gridftp_attr_cntl\fP (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_CONTROL_PROTECTION\fP, int *protection_out)" .br .in -1c .SH "Detailed Description" .PP XIO GRIDFTP Client Driver\&. .SH "Function Documentation" .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_APPEND\fP, globus_bool_t * append_out)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get the append flag on the attr\&. .PP \fBParameters\fP .RS 4 \fIappend_out\fP The append flag will be stored here\&. .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_AUTH\fP, gss_cred_id_t * credential_out, const char ** user_out, const char ** password_out, const char ** account_out, const char ** subject_out)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get the authentication information on the attr\&. .PP \fBParameters\fP .RS 4 \fIcredential_out\fP The credential will be stored here\&. .br \fIuser_out\fP The user name will be stored here\&. .br \fIpassword_out\fP The password will be stored here\&. .br \fIaccount_out\fP The account information will be stored here\&. .br \fIsubject_out\fP The subject name will be stored here\&. .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_CONTROL_PROTECTION\fP, int * protection_out)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get the control channel protection level on the attr\&. .PP \fBParameters\fP .RS 4 \fIprotection_out\fP The control channel protection level will be stored here\&. .RE .PP \fBSee also\fP .RS 4 globus_l_xio_gridftp_protection_t .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_DATA_PROTECTION\fP, int * protection_out)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get the data channel protection level on the attr\&. .PP \fBParameters\fP .RS 4 \fIprotection_out\fP The data channel protection level will be stored here\&. .RE .PP \fBSee also\fP .RS 4 globus_l_xio_gridftp_dcau_mode_t .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_DCAU\fP, int * dcau_mode_out)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get the data channel authentication mode on the attr\&. .PP \fBParameters\fP .RS 4 \fIdcau_mode_out\fP The data channel authentication mode will be stored here\&. .RE .PP \fBSee also\fP .RS 4 globus_l_xio_gridftp_dcau_mode_t .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_ERET\fP, char ** eret_alg_str_out)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get the ERET algorithm string\&. .PP \fBParameters\fP .RS 4 \fIeret_alg_str_out\fP The ERET algorithm string will be stored here\&. It is the responsibility of the user to free the memory allocated for this string\&. .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_ESTO\fP, char ** esto_alg_str_out)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get the ESTO algorithm string\&. .PP \fBParameters\fP .RS 4 \fIesto_alg_str_out\fP The ESTO algorithm string will be stored here\&. It is the responsibility of the user to free the memory allocated for this string\&. .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_HANDLE\fP, globus_ftp_client_handle_t ** ftp_handle_out)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get the ftp client handle on the attr\&. .PP \fBParameters\fP .RS 4 \fIftp_handle_out\fP The ftp client handle pointer will be stored here\&. If none is set, NULL will be set\&. .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_MODE\fP, int * mode_out)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get the data transmission mode on the attr\&. .PP \fBParameters\fP .RS 4 \fImode_out\fP The data transmission mode will be stored here\&. .RE .PP \fBSee also\fP .RS 4 \fBglobus_l_xio_gridftp_mode_t\fP .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_NUM_STREAMS\fP, int * num_streams_out)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get the number of TCP streams on the attr\&. .PP \fBParameters\fP .RS 4 \fInum_streams_out\fP The stream count will be stored here\&. .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_PARTIAL_TRANSFER\fP, globus_bool_t * partial_xfer_out)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get the partial transfer flag on the attr\&. .PP \fBParameters\fP .RS 4 \fIpartial_xfer_out\fP The partial xfer flag will be stored here\&. .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_GET_TCP_BUFFER\fP, int * buf_size_out)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Get the TCP socket send/recv buffer size on the attr\&. .PP \fBParameters\fP .RS 4 \fIbuf_size_out\fP The send/recv buffer size will be stored here\&. .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_APPEND\fP, globus_bool_t append)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Enable or disable opening the file in append mode\&. .PP \fBParameters\fP .RS 4 \fIappend\fP GLOBUS_TRUE to enable, GLOBUS_FALSE to disable (default)\&. .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_AUTH\fP, gss_cred_id_t credential, const char * user, const char * password, const char * account, const char * subject)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the authentication information used to authenticate with the GridFTP server .PP \fBParameters\fP .RS 4 \fIcredential\fP The credential to use for authenticating with a GridFTP server\&. This may be GSS_C_NO_CREDENTIAL to use the default credential\&. .br \fIuser\fP The user name to send to the GridFTP server\&. When doing a GSI transfer, this may be set to NULL, and the default gridmap entry for the user's GSI identity will be used .br \fIpassword\fP The password to send to the GridFTP server\&. When doing a GSI transfer, this may be set to NULL\&. .br \fIaccount\fP The account to use for the data transfer\&. .br \fIsubject\fP The subject name of the GridFTP server\&. This is only used when doing a GSI transfer, and then only when the security subject name does not match the hostname of the server (ie, when the server is being run by a user)\&. .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_CONTROL_PROTECTION\fP, int protection)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set protection level on the control channel\&. .PP \fBParameters\fP .RS 4 \fIprotection\fP Specifies the protection level\&. .RE .PP \fBSee also\fP .RS 4 globus_l_xio_gridftp_protection_t .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_DATA_PROTECTION\fP, int protection)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set protection level on the data channel\&. .PP \fBParameters\fP .RS 4 \fIprotection\fP Specifies the protection level\&. .RE .PP \fBSee also\fP .RS 4 globus_l_xio_gridftp_protection_t .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_DCAU\fP, int dcau_mode)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the mode of authentication to be performed on GridFTP data channels\&. .PP \fBParameters\fP .RS 4 \fIdcau_mode\fP Specifies the authentication mode\&. .RE .PP \fBSee also\fP .RS 4 globus_l_xio_gridftp_dcau_mode_t .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_ERET\fP, const char * eret_alg_str)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the ERET algorithm string\&. This string contains information needed to invoke a server-specific data reduction algorithm on the file being retrieved\&. .PP \fBParameters\fP .RS 4 \fIeret_alg_str\fP Specifies the ERET algorithm string\&. .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_ESTO\fP, const char * esto_alg_str)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the ESTO algorithm string\&. This string contains information needed to invoke a server-specific data reduction algorithm on the file being stored\&. .PP \fBParameters\fP .RS 4 \fIesto_alg_str\fP Specifies the ESTO algorithm string\&. .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_HANDLE\fP, globus_ftp_client_handle_t * ftp_handle)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the ftp client handle to use\&. .PP Do not create a new ftp client handle, use this handle instead\&. .PP \fBParameters\fP .RS 4 \fIftp_handle\fP Specifies the pointer to globus ftp client handle\&. Note: this handle will not be destroyed\&. .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_MODE\fP, int mode)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the transmission mode used for data transfer .PP \fBParameters\fP .RS 4 \fImode\fP Specifies the data transmission mode\&. (default is stream mode) .RE .PP \fBSee also\fP .RS 4 \fBglobus_l_xio_gridftp_mode_t\fP .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_NUM_STREAMS\fP, int num_streams)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the number of TCP streams to be used between the client and the server\&. .PP \fBParameters\fP .RS 4 \fInum_streams\fP Specifies the number of streams to use\&. .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_PARTIAL_TRANSFER\fP, globus_bool_t partial_xfer)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Enable or disable partial transfer (associate a transfer with each read/write) on the GridFTP handle\&. .PP \fBParameters\fP .RS 4 \fIpartial_xfer\fP GLOBUS_TRUE to enable, GLOBUS_FALSE to disable (default)\&. .RE .PP .SS "globus_result_t globus_xio_gridftp_attr_cntl (attr, driver, \fBGLOBUS_XIO_GRIDFTP_SET_TCP_BUFFER\fP, int buf_size)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Set the TCP socket send/recv buffer size\&. .PP \fBParameters\fP .RS 4 \fIbuf_size\fP The send/recv buffer size in bytes to use\&. (default is system specific) .RE .PP .SS "globus_result_t globus_xio_gridftp_handle_cntl (handle, driver, \fBGLOBUS_XIO_GRIDFTP_SEEK\fP, globus_off_t seek_offset)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. Reposition the offset of the file being read/written\&. .PP \fBParameters\fP .RS 4 \fIseek_offset\fP Specifies the desired offset\&. .RE .PP .SH "Author" .PP Generated automatically by Doxygen for globus_xio_gridftp_driver from the source code\&.