.TH "globus_gass_transfer.h" 3 "Tue Jul 5 2022" "Version 9.4" "globus_gass_transfer" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gass_transfer.h \- GASS transfer\&.  

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

.SS "Macros"

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

.in +1c
.ti -1c
.RI "typedef void(* \fBglobus_gass_transfer_close_callback_t\fP) (void *callback_arg, globus_gass_transfer_listener_t listener)"
.br
.ti -1c
.RI "typedef void(* \fBglobus_gass_transfer_listen_callback_t\fP) (void *callback_arg, globus_gass_transfer_listener_t listener)"
.br
.ti -1c
.RI "typedef void(* \fBglobus_gass_transfer_bytes_callback_t\fP) (void *arg, \fBglobus_gass_transfer_request_t\fP request, globus_byte_t *bytes, globus_size_t length, globus_bool_t last_data)"
.br
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBglobus_gass_transfer_request_type_t\fP { \fBGLOBUS_GASS_TRANSFER_REQUEST_TYPE_INVALID\fP, \fBGLOBUS_GASS_TRANSFER_REQUEST_TYPE_GET\fP, \fBGLOBUS_GASS_TRANSFER_REQUEST_TYPE_PUT\fP, \fBGLOBUS_GASS_TRANSFER_REQUEST_TYPE_APPEND\fP }"
.br
.ti -1c
.RI "enum \fBglobus_gass_transfer_request_status_t\fP { \fBGLOBUS_GASS_TRANSFER_REQUEST_INVALID\fP, \fBGLOBUS_GASS_TRANSFER_REQUEST_STARTING\fP, \fBGLOBUS_GASS_TRANSFER_REQUEST_PENDING\fP, \fBGLOBUS_GASS_TRANSFER_REQUEST_FAILED\fP, \fBGLOBUS_GASS_TRANSFER_REQUEST_REFERRED\fP, \fBGLOBUS_GASS_TRANSFER_REQUEST_DENIED\fP, \fBGLOBUS_GASS_TRANSFER_REQUEST_DONE\fP }"
.br
.ti -1c
.RI "enum { \fBGLOBUS_GASS_TRANSFER_ERROR_BAD_PORT\fP = 2, \fBGLOBUS_GASS_TRANSFER_ERROR_INTERNAL_ERROR\fP, \fBGLOBUS_GASS_TRANSFER_ERROR_BAD_URL\fP, \fBGLOBUS_GASS_TRANSFER_ERROR_NOT_SUPPORTED\fP, \fBGLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED\fP, \fBGLOBUS_GASS_TRANSFER_ERROR_MALLOC_FAILED\fP, \fBGLOBUS_GASS_TRANSFER_ERROR_NOT_INITIALIZED\fP, \fBGLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER\fP, \fBGLOBUS_GASS_TRANSFER_ERROR_NOT_REGISTERED\fP, \fBGLOBUS_GASS_TRANSFER_ERROR_NOT_FOUND\fP, \fBGLOBUS_GASS_TRANSFER_ERROR_INVALID_USE\fP, \fBGLOBUS_GASS_TRANSFER_ERROR_TOO_LARGE\fP, \fBGLOBUS_GASS_TRANSFER_ERROR_REQUEST_FAILED\fP, \fBGLOBUS_GASS_TRANSFER_ERROR_DONE\fP, \fBGLOBUS_GASS_TRANSFER_ERROR_ALREADY_REGISTERED\fP, \fBGLOBUS_GASS_TRANSFER_ERROR_OPEN_FAILED\fP, \fBGLOBUS_GASS_TRANSFER_ERROR_TRANSFER_FAILED\fP }"
.br
.ti -1c
.RI "enum "
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBglobus_gass_transfer_register_get\fP (\fBglobus_gass_transfer_request_t\fP *request, globus_gass_transfer_requestattr_t *attr, char *url, globus_gass_transfer_callback_t callback, void *user_arg)"
.br
.ti -1c
.RI "int \fBglobus_gass_transfer_get\fP (\fBglobus_gass_transfer_request_t\fP *request, globus_gass_transfer_requestattr_t *attr, char *url)"
.br
.ti -1c
.RI "int \fBglobus_gass_transfer_register_put\fP (\fBglobus_gass_transfer_request_t\fP *request, globus_gass_transfer_requestattr_t *attr, char *url, globus_size_t length, globus_gass_transfer_callback_t callback, void *user_arg)"
.br
.ti -1c
.RI "int \fBglobus_gass_transfer_put\fP (\fBglobus_gass_transfer_request_t\fP *request, globus_gass_transfer_requestattr_t *attr, char *url, globus_size_t length)"
.br
.ti -1c
.RI "int \fBglobus_gass_transfer_register_append\fP (\fBglobus_gass_transfer_request_t\fP *request, globus_gass_transfer_requestattr_t *attr, char *url, globus_size_t length, globus_gass_transfer_callback_t callback, void *user_arg)"
.br
.ti -1c
.RI "int \fBglobus_gass_transfer_append\fP (\fBglobus_gass_transfer_request_t\fP *request, globus_gass_transfer_requestattr_t *attr, char *url, globus_size_t length)"
.br
.ti -1c
.RI "int \fBglobus_gass_transfer_create_listener\fP (globus_gass_transfer_listener_t *listener, globus_gass_transfer_listenerattr_t *attr, char *scheme)"
.br
.ti -1c
.RI "int \fBglobus_gass_transfer_close_listener\fP (globus_gass_transfer_listener_t listener, \fBglobus_gass_transfer_close_callback_t\fP callback, void *user_arg)"
.br
.ti -1c
.RI "int \fBglobus_gass_transfer_register_listen\fP (globus_gass_transfer_listener_t listener, \fBglobus_gass_transfer_listen_callback_t\fP callback, void *user_arg)"
.br
.ti -1c
.RI "int \fBglobus_gass_transfer_register_accept\fP (\fBglobus_gass_transfer_request_t\fP *request, globus_gass_transfer_requestattr_t *attr, globus_gass_transfer_listener_t listener, globus_gass_transfer_callback_t callback, void *user_arg)"
.br
.ti -1c
.RI "int \fBglobus_gass_transfer_refer\fP (\fBglobus_gass_transfer_request_t\fP request, char **urls, globus_size_t num_urls)"
.br
.ti -1c
.RI "int \fBglobus_gass_transfer_authorize\fP (\fBglobus_gass_transfer_request_t\fP request, globus_size_t total_length)"
.br
.ti -1c
.RI "int \fBglobus_gass_transfer_deny\fP (\fBglobus_gass_transfer_request_t\fP request, int reason, char *message)"
.br
.ti -1c
.RI "char * \fBglobus_gass_transfer_listener_get_base_url\fP (globus_gass_transfer_listener_t listener)"
.br
.ti -1c
.RI "void * \fBglobus_gass_transfer_listener_get_user_pointer\fP (globus_gass_transfer_listener_t listener)"
.br
.ti -1c
.RI "int \fBglobus_gass_transfer_listener_set_user_pointer\fP (globus_gass_transfer_listener_t listener, void *user_pointer)"
.br
.ti -1c
.RI "int \fBglobus_gass_transfer_send_bytes\fP (\fBglobus_gass_transfer_request_t\fP request, globus_byte_t *bytes, globus_size_t send_length, globus_bool_t last_data, \fBglobus_gass_transfer_bytes_callback_t\fP callback, void *user_arg)"
.br
.ti -1c
.RI "int \fBglobus_gass_transfer_receive_bytes\fP (\fBglobus_gass_transfer_request_t\fP request, globus_byte_t *bytes, globus_size_t max_length, globus_size_t wait_for_length, \fBglobus_gass_transfer_bytes_callback_t\fP callback, void *user_arg)"
.br
.ti -1c
.RI "globus_object_t * \fBglobus_gass_transfer_requestattr_initialize\fP (globus_object_t *obj, char *proxy_url, globus_size_t block_size, globus_gass_transfer_file_mode_t file_mode, globus_bool_t connection_reuse)"
.br
.ti -1c
.RI "globus_object_t * \fBglobus_gass_transfer_socket_requestattr_initialize\fP (globus_object_t *obj, char *proxy_url, globus_size_t block_size, globus_gass_transfer_file_mode_t file_mode, globus_bool_t connection_reuse, int sndbuf, int rcvbuf, globus_bool_t nodelay)"
.br
.ti -1c
.RI "globus_object_t * \fBglobus_gass_transfer_secure_requestattr_initialize\fP (globus_object_t *obj, char *proxy_url, globus_size_t block_size, globus_gass_transfer_file_mode_t file_mode, globus_bool_t connection_reuse, int sndbuf, int rcvbuf, globus_bool_t nodelay, globus_gass_transfer_authorization_t authorization, char *subject)"
.br
.ti -1c
.RI "globus_object_t * \fBglobus_gass_transfer_listenerattr_initialize\fP (globus_object_t *obj, int backlog, unsigned short port)"
.br
.in -1c
.SH "Detailed Description"
.PP 
GASS transfer\&. 


.SH "Macro Definition Documentation"
.PP 
.SS "#define GLOBUS_GASS_TRANSFER_LENGTH_UNKNOWN"
Value for files we don't know the length of\&. 
.SS "#define GLOBUS_GASS_TRANSFER_TIMESTAMP_UNKNOWN"
Value for timestamps we don't know the value of\&. 
.SH "Enumeration Type Documentation"
.PP 
.SS "anonymous enum"
GASS error codes 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_BAD_PORT \fP\fP
Invalid port in URL 
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_INTERNAL_ERROR \fP\fP
Something bad occurred while processing the request 
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_BAD_URL \fP\fP
Unparsable URL 
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_NOT_SUPPORTED \fP\fP
Invalid file open mode in the GASS File library 
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED \fP\fP
Operation not supported by GASS for this type of URL 
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_MALLOC_FAILED \fP\fP
Out of memory 
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_NOT_INITIALIZED \fP\fP
Uninitialized or invalid handle 
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER \fP\fP
NULL pointer passed as parameter 
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_NOT_REGISTERED \fP\fP
GASS Server not yet registered 
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_NOT_FOUND \fP\fP
URL not in cache 
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_INVALID_USE \fP\fP
Invalid use of a GASS handle 
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_TOO_LARGE \fP\fP
Bytes array exceeds GASS request size 
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_REQUEST_FAILED \fP\fP
GASS Transfer request did not complete successfully 
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_DONE \fP\fP
GASS handle already closed before this operation began 
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_ALREADY_REGISTERED \fP\fP
GASS handle already registered for processing 
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_OPEN_FAILED \fP\fP
Could not open local file 
.TP
\fB\fIGLOBUS_GASS_TRANSFER_ERROR_TRANSFER_FAILED \fP\fP
A protocol error or client-initiated failure has occurred 
.SS "anonymous enum"
Default buffer length for the globus_gass_transfer_assist library\&. 
.SH "Author"
.PP 
Generated automatically by Doxygen for globus_gass_transfer from the source code\&.