.TH "globus_gass_transfer_requestattr" 3 "Tue Jul 5 2022" "Version 9.4" "globus_gass_transfer" \" -*- nroff -*- .ad l .nh .SH NAME globus_gass_transfer_requestattr \- Request Attributes .PP \- Request Attributes\&. .SH SYNOPSIS .br .PP .SS "Functions" .in +1c .ti -1c .RI "int \fBglobus_gass_transfer_requestattr_init\fP (globus_gass_transfer_requestattr_t *attr, char *url_scheme)" .br .ti -1c .RI "int \fBglobus_gass_transfer_requestattr_destroy\fP (globus_gass_transfer_requestattr_t *attr)" .br .in -1c .SS "Proxy Server" .in +1c .ti -1c .RI "int \fBglobus_gass_transfer_requestattr_set_proxy_url\fP (globus_gass_transfer_requestattr_t *attr, char *proxy_url)" .br .ti -1c .RI "int \fBglobus_gass_transfer_requestattr_get_proxy_url\fP (globus_gass_transfer_requestattr_t *attr, char **proxy_url)" .br .in -1c .SS "Block Size" .in +1c .ti -1c .RI "int \fBglobus_gass_transfer_requestattr_set_block_size\fP (globus_gass_transfer_requestattr_t *attr, globus_size_t block_size)" .br .ti -1c .RI "int \fBglobus_gass_transfer_requestattr_get_block_size\fP (globus_gass_transfer_requestattr_t *attr, globus_size_t *block_size)" .br .in -1c .SS "File Mode" .in +1c .ti -1c .RI "int \fBglobus_gass_transfer_requestattr_set_file_mode\fP (globus_gass_transfer_requestattr_t *attr, globus_gass_transfer_file_mode_t file_mode)" .br .ti -1c .RI "int \fBglobus_gass_transfer_requestattr_get_file_mode\fP (globus_gass_transfer_requestattr_t *attr, globus_gass_transfer_file_mode_t *file_mode)" .br .in -1c .SS "Connection Reuse" .in +1c .ti -1c .RI "int \fBglobus_gass_transfer_requestattr_set_connection_reuse\fP (globus_gass_transfer_requestattr_t *attr, globus_bool_t connection_reuse)" .br .ti -1c .RI "int \fBglobus_gass_transfer_requestattr_get_connection_reuse\fP (globus_gass_transfer_requestattr_t *attr, 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 .in -1c .SS "Socket Send Buffer Size" .in +1c .ti -1c .RI "int \fBglobus_gass_transfer_requestattr_set_socket_sndbuf\fP (globus_gass_transfer_requestattr_t *attr, int sndbuf)" .br .ti -1c .RI "int \fBglobus_gass_transfer_requestattr_get_socket_sndbuf\fP (globus_gass_transfer_requestattr_t *attr, int *sndbuf)" .br .in -1c .SS "Receive Socket Buffer" .in +1c .ti -1c .RI "int \fBglobus_gass_transfer_requestattr_set_socket_rcvbuf\fP (globus_gass_transfer_requestattr_t *attr, int rcvbuf)" .br .ti -1c .RI "int \fBglobus_gass_transfer_requestattr_get_socket_rcvbuf\fP (globus_gass_transfer_requestattr_t *attr, int *rcvbuf)" .br .in -1c .SS "TCP Nodelay" .in +1c .ti -1c .RI "int \fBglobus_gass_transfer_requestattr_set_socket_nodelay\fP (globus_gass_transfer_requestattr_t *attr, globus_bool_t nodelay)" .br .ti -1c .RI "int \fBglobus_gass_transfer_requestattr_get_socket_nodelay\fP (globus_gass_transfer_requestattr_t *attr, 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 .in -1c .SS "Authorization" .in +1c .ti -1c .RI "int \fBglobus_gass_transfer_secure_requestattr_set_authorization\fP (globus_gass_transfer_requestattr_t *attr, globus_gass_transfer_authorization_t mode, char *subject)" .br .ti -1c .RI "int \fBglobus_gass_transfer_secure_requestattr_get_authorization\fP (globus_gass_transfer_requestattr_t *attr, globus_gass_transfer_authorization_t *mode, 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 .ti -1c .RI "int \fBglobus_gass_transfer_listenerattr_init\fP (globus_gass_transfer_listenerattr_t *attr, char *url_scheme)" .br .in -1c .SH "Detailed Description" .PP Request Attributes\&. The GASS Transfer library uses Globus objects to provide an extensible way of creating protocol-specific attributes\&. .SH "Function Documentation" .PP .SS "int globus_gass_transfer_listenerattr_init (globus_gass_transfer_listenerattr_t * attr, char * url_scheme)" Initialize a listener attribute\&. .PP This function initializes the \fIattr\fP to contain a new protocol-specific listener attribute\&. .PP \fBParameters\fP .RS 4 \fIattr\fP The attribute set to be initialized\&. .br \fIurl_scheme\fP The scheme which which the attribute will be used for\&. .RE .PP \fBReturn values\fP .RS 4 \fIGLOBUS_SUCCESS\fP The attribute was successfully initialized\&. .br \fIGLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER\fP Either \fIattr\fP or \fIurl_scheme\fP was GLOBUS_NULL\&. .br \fIGLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED\fP No protocol module currently registered with GASS Transfer Library handles URLs with the specified \fIurl_scheme\fP\&. .RE .PP .SS "globus_object_t* globus_gass_transfer_listenerattr_initialize (globus_object_t * obj, int backlog, unsigned short port)" Initialize a base listener attribute\&. .PP \fBParameters\fP .RS 4 \fIobj\fP .br \fIbacklog\fP .br \fIport\fP .RE .PP \fBReturns\fP .RS 4 Returns the \fIobj\fP pointer if the object inherited from the \fIGLOBUS_GASS_OBJECT_TYPE_LISTENERTATTR\fP type and the attribute could be initialized; GLOBUS_NULL otherwise\&. .RE .PP .SS "int globus_gass_transfer_requestattr_destroy (globus_gass_transfer_requestattr_t * attr)" Destroy a request attribute\&. .PP This function destroys the attribute set specified in \fIattr\fP\&. .PP \fBParameters\fP .RS 4 \fIattr\fP The attribute set to be destroyed\&. .RE .PP \fBReturn values\fP .RS 4 \fIGLOBUS_SUCCESS\fP The attribute was successfully destroyed\&. .br \fIGLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER\fP The \fIattr\fP was GLOBUS_NULL\&. .RE .PP .SS "int globus_gass_transfer_requestattr_init (globus_gass_transfer_requestattr_t * attr, char * url_scheme)" Initialize a request attribute\&. .PP This function initializes the \fIattr\fP to contain a new protocol-specific request attribute\&. .PP \fBParameters\fP .RS 4 \fIattr\fP The attribute set to be initialized\&. .br \fIurl_scheme\fP The scheme which which the attribute will be used for\&. .RE .PP \fBReturn values\fP .RS 4 \fIGLOBUS_SUCCESS\fP The attribute was successfully initialized\&. .br \fIGLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER\fP Either \fIattr\fP or \fIurl_scheme\fP was GLOBUS_NULL\&. .br \fIGLOBUS_GASS_TRANSFER_ERROR_NOT_IMPLEMENTED\fP No protocol module currently registered with GASS Transfer Library handles URLs with the specified \fIurl_scheme\fP\&. .RE .PP .SS "int globus_gass_transfer_requestattr_set_block_size (globus_gass_transfer_requestattr_t * attr, globus_size_t block_size)" Set/Get the block size attribute for a GASS transfer attribute set\&. .PP This attribute allows the user to suggest a preferred block size of a server to handle a URL request\&. .PP \fBParameters\fP .RS 4 \fIattr\fP The attribute set to query or modify\&. .br \fIblock_size\fP The data block size that should be used to process requests with this attribute set\&. .RE .PP \fBReturn values\fP .RS 4 \fIGLOBUS_SUCCESS\fP The attribute was successfully updated\&. .br \fIGLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER\fP The \fIattr\fP was GLOBUS_NULL\&. .RE .PP .SS "int globus_gass_transfer_requestattr_set_connection_reuse (globus_gass_transfer_requestattr_t * attr, globus_bool_t connection_reuse)" Set/Get the connection reuse attribute for a GASS transfer attribute set\&. .PP This attribute allows the user to control whether the connection associated with a GASS Transfer request should be reused after the file transfer has completed\&. .PP \fBParameters\fP .RS 4 \fIattr\fP The attribute set to query or modify\&. .br \fIconnection_reuse\fP The value of the connection reuse attribute\&. .RE .PP \fBReturn values\fP .RS 4 \fIGLOBUS_SUCCESS\fP The attribute was successfully updated\&. .br \fIGLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER\fP The \fIattr\fP was GLOBUS_NULL\&. .RE .PP .SS "int globus_gass_transfer_requestattr_set_file_mode (globus_gass_transfer_requestattr_t * attr, globus_gass_transfer_file_mode_t file_mode)" Set/Get the file mode attribute for a GASS transfer attribute set\&. .PP This attribute allows the user to control whether the file will be transferred in ASCII or binary file mode\&. .PP \fBParameters\fP .RS 4 \fIattr\fP The attribute set to query or modify\&. .br \fIfile_mode\fP The value of the file mode attribute\&. .RE .PP \fBReturn values\fP .RS 4 \fIGLOBUS_SUCCESS\fP The attribute was successfully updated\&. .br \fIGLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER\fP The \fIattr\fP was GLOBUS_NULL\&. .RE .PP .SS "int globus_gass_transfer_requestattr_set_proxy_url (globus_gass_transfer_requestattr_t * attr, char * proxy_url)" Set/Get the proxy server attribute for a GASS transfer attribute set\&. .PP This attribute allows the user to use a proxy server to handle a URL request\&. .PP \fBParameters\fP .RS 4 \fIattr\fP The attribute set to be modified .br \fIproxy_url\fP The new value of the proxy_url attribute\&. This may be GLOBUS_NULL if no proxy is to be used to access URLs with this attribute set\&. .RE .PP \fBReturn values\fP .RS 4 \fIGLOBUS_SUCCESS\fP The attribute was successfully updated\&. .br \fIGLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER\fP The \fIattr\fP was GLOBUS_NULL\&. .RE .PP .SS "int globus_gass_transfer_requestattr_set_socket_nodelay (globus_gass_transfer_requestattr_t * attr, globus_bool_t nodelay)" Set/Get the TCP nodelay attribute for a GASS transfer attribute set\&. .PP This attribute allows the user to control the socket receive buffer associated with a GASS Transfer request should be reused after the file transfer has completed\&. .PP \fBParameters\fP .RS 4 \fIattr\fP The attribute set to query or modify\&. .br \fInodelay\fP The value of the nodelay attribute\&. .RE .PP \fBReturn values\fP .RS 4 \fIGLOBUS_SUCCESS\fP The attribute was successfully updated\&. .br \fIGLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER\fP The \fIattr\fP was GLOBUS_NULL\&. .RE .PP .SS "int globus_gass_transfer_requestattr_set_socket_rcvbuf (globus_gass_transfer_requestattr_t * attr, int rcvbuf)" Set/Get the receive buffer size attribute for a GASS transfer attribute set\&. .PP This attribute allows the user to control the socket receive buffer associated with a GASS Transfer request should be reused after the file transfer has completed\&. .PP \fBParameters\fP .RS 4 \fIattr\fP The attribute set to query or modify\&. .br \fIrcvbuf\fP The value of the socket buffer\&. .RE .PP \fBReturn values\fP .RS 4 \fIGLOBUS_SUCCESS\fP The attribute was successfully updated\&. .br \fIGLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER\fP The \fIattr\fP was GLOBUS_NULL\&. .RE .PP .SS "int globus_gass_transfer_requestattr_set_socket_sndbuf (globus_gass_transfer_requestattr_t * attr, int sndbuf)" Set/Get the send buffer size attribute for a GASS transfer attribute set\&. .PP This attribute allows the user to control the socket send buffer associated with a GASS Transfer request should be reused after the file transfer has completed\&. .PP \fBParameters\fP .RS 4 \fIattr\fP The attribute set to query or modify\&. .br \fIsndbuf\fP The value of the socket buffer\&. .RE .PP \fBReturn values\fP .RS 4 \fIGLOBUS_SUCCESS\fP The attribute was successfully updated\&. .br \fIGLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER\fP The \fIattr\fP was GLOBUS_NULL\&. .RE .PP .SS "globus_object_t* globus_gass_transfer_secure_requestattr_initialize (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)" Initialize a secure request attribute\&. .PP \fBParameters\fP .RS 4 \fIobj\fP .br \fIproxy_url\fP .br \fIblock_size\fP .br \fIfile_mode\fP .br \fIconnection_reuse\fP .br \fIsndbuf\fP .br \fIrcvbuf\fP .br \fInodelay\fP .br \fIauthorization\fP .br \fIsubject\fP .RE .PP \fBReturns\fP .RS 4 Returns the \fIobj\fP pointer if the object inherited from the \fIGLOBUS_GASS_OBJECT_TYPE_SECURE_REQUESTATTR\fP type and the attribute could be initialized; GLOBUS_NULL otherwise\&. .RE .PP .SS "int globus_gass_transfer_secure_requestattr_set_authorization (globus_gass_transfer_requestattr_t * attr, globus_gass_transfer_authorization_t mode, char * subject)" Set/Get the authorization attribute for a GASS transfer attribute set\&. .PP This attribute allows the user to control what type of authorization should be done when GASS Transfer requests are processed\&. .PP \fBParameters\fP .RS 4 \fIattr\fP The attribute set to query or modify\&. .br \fImode\fP The authorization mode to use\&. .br \fIsubject\fP The subject name of the authorized subject, if \fImode\fP is GLOBUS_GASS_TRANSFER_AUTHORIZE_SUBJECT .RE .PP \fBReturn values\fP .RS 4 \fIGLOBUS_SUCCESS\fP The attribute was successfully updated\&. .br \fIGLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER\fP The \fIattr\fP was GLOBUS_NULL\&. .RE .PP .SS "globus_object_t* globus_gass_transfer_socket_requestattr_initialize (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)" Initialize a socket request attribute\&. .PP \fBParameters\fP .RS 4 \fIobj\fP .br \fIproxy_url\fP .br \fIblock_size\fP .br \fIfile_mode\fP .br \fIconnection_reuse\fP .br \fIsndbuf\fP .br \fIrcvbuf\fP .br \fInodelay\fP .RE .PP \fBReturns\fP .RS 4 Returns the \fIobj\fP pointer if the object inherited from the \fIGLOBUS_GASS_OBJECT_TYPE_SOCKET_REQUESTATTR\fP type and the attribute could be initialized; GLOBUS_NULL otherwise\&. .RE .PP .SH "Author" .PP Generated automatically by Doxygen for globus_gass_transfer from the source code\&.