.TH "globus_gass_transfer_proto_descriptor_t" 3 "Tue Jul 5 2022" "Version 9.4" "globus_gass_transfer" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_gass_transfer_proto_descriptor_t \- Protocol module descriptor structure\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <globus_gass_transfer_proto\&.h>\fP
.SS "Data Fields"

.in +1c
.ti -1c
.RI "char * \fBurl_scheme\fP"
.br
.ti -1c
.RI "\fBglobus_gass_transfer_proto_new_attr_t\fP \fBnew_requestattr\fP"
.br
.ti -1c
.RI "\fBglobus_gass_transfer_proto_new_request_t\fP \fBnew_request\fP"
.br
.ti -1c
.RI "\fBglobus_gass_transfer_proto_new_attr_t\fP \fBnew_listenerattr\fP"
.br
.ti -1c
.RI "\fBglobus_gass_transfer_proto_create_listener_t\fP \fBnew_listener\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Protocol module descriptor structure\&. 


.PP
\fBSee also\fP
.RS 4
\fBglobus_gass_transfer_proto_register_protocol()\fP, \fBglobus_gass_transfer_proto_unregister_protocol()\fP 
.RE
.PP

.SH "Field Documentation"
.PP 
.SS "\fBglobus_gass_transfer_proto_create_listener_t\fP globus_gass_transfer_proto_descriptor_t::new_listener"
New listener\&.
.PP
The function pointed to by this pointer is used by GASS to create a new listener handle\&. The listener handle has been initialized with the parameters passed to one of the functions in the \fBClient-Initiated Operations\fP section of the GASS Transfer API\&.
.PP
The protocol module should begin processing this request by sending appropriate messages to the file server\&. Once the request is authorized, denied, or referred, the protocol module calls \fBglobus_gass_transfer_proto_request_ready()\fP, \fBglobus_gass_transfer_proto_request_denied()\fP, or \fBglobus_gass_transfer_proto_request_referred()\fP\&.
.PP
\fBSee also\fP
.RS 4
\fBglobus_gass_transfer_proto_new_request_t\fP 
.RE
.PP

.SS "\fBglobus_gass_transfer_proto_new_attr_t\fP globus_gass_transfer_proto_descriptor_t::new_listenerattr"
New listener attributes\&.
.PP
The function pointed to by this pointer is used by GASS to forward requests to create a listener attribute for this protocol's \fIurl_scheme\fP to the protocol module\&. The function returns a listener attribute which inherits from one of the GASS Transfer request attributes\&.
.PP
\fBSee also\fP
.RS 4
\fBglobus_gass_transfer_proto_new_attr_t\fP 
.RE
.PP

.SS "\fBglobus_gass_transfer_proto_new_request_t\fP globus_gass_transfer_proto_descriptor_t::new_request"
New request\&.
.PP
The function pointed to by this pointer is used by GASS to initiate a new file transfer request by a protocol module\&. The request handle has been initialized with the parameters passed to one of the functions in the \fBClient-Initiated Operations\fP section of the GASS Transfer API\&.
.PP
The protocol module should begin processing this request by sending appropriate messages to the file server\&. Once the request is authorized, denied, or referred, the protocol module calls \fBglobus_gass_transfer_proto_request_ready()\fP, \fBglobus_gass_transfer_proto_request_denied()\fP, or \fBglobus_gass_transfer_proto_request_referred()\fP\&.
.PP
\fBSee also\fP
.RS 4
\fBglobus_gass_transfer_proto_new_request_t\fP 
.RE
.PP

.SS "\fBglobus_gass_transfer_proto_new_attr_t\fP globus_gass_transfer_proto_descriptor_t::new_requestattr"
New request attributes\&.
.PP
The function pointed to by this pointer is used by GASS to forward requests to create a request attribute for this protocol's \fIurl_scheme\fP to the protocol module\&. The function returns a request attribute which inherits from one of the GASS Transfer request attributes\&.
.PP
\fBSee also\fP
.RS 4
\fBglobus_gass_transfer_proto_new_attr_t\fP 
.RE
.PP

.SS "char* globus_gass_transfer_proto_descriptor_t::url_scheme"
URL Scheme\&.
.PP
The URL scheme which this protocol module supports\&. The scheme is the first part of a URL, which names the protocol which is used to access the resource named by the URL, for example 'http' or 'ftp'\&.
.PP
The GASS Transfer library allows only one protocol module to be registered to handle a particular \fIurl_scheme\fP\&. However, a protocol module may implement only the client or only the server part of the protocol\&. If a protocol has several variations with different scheme names (for example http and https), each scheme must be registered with GASS in order to be used\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for globus_gass_transfer from the source code\&.