globus_gass_transfer_proto_descriptor_t(3)

NAME
globus_gass_transfer_proto_descriptor_t - Protocol module descriptor structure.

SYNOPSIS

#include <globus_gass_transfer_proto.h>

  Data Fields

char * url_scheme
globus_gass_transfer_proto_new_attr_t new_requestattr
globus_gass_transfer_proto_new_request_t new_request
globus_gass_transfer_proto_new_attr_t new_listenerattr
globus_gass_transfer_proto_create_listener_t new_listener

Detailed Description

Protocol module descriptor structure.

See also
    globus_gass_transfer_proto_register_protocol(), globus_gass_transfer_proto_unregister_protocol()

Field Documentation

  globus_gass_transfer_proto_create_listener_t globus_gass_transfer_proto_descriptor_t::new_listener
New listener.

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 Client-Initiated Operations section of the GASS Transfer API.

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 globus_gass_transfer_proto_request_ready(), globus_gass_transfer_proto_request_denied(), or globus_gass_transfer_proto_request_referred().

See also
    globus_gass_transfer_proto_new_request_t

  globus_gass_transfer_proto_new_attr_t globus_gass_transfer_proto_descriptor_t::new_listenerattr
New listener attributes.

The function pointed to by this pointer is used by GASS to forward requests to create a listener attribute for this protocol's url_scheme to the protocol module. The function returns a listener attribute which inherits from one of the GASS Transfer request attributes.

See also
    globus_gass_transfer_proto_new_attr_t

  globus_gass_transfer_proto_new_request_t globus_gass_transfer_proto_descriptor_t::new_request
New request.

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 Client-Initiated Operations section of the GASS Transfer API.

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 globus_gass_transfer_proto_request_ready(), globus_gass_transfer_proto_request_denied(), or globus_gass_transfer_proto_request_referred().

See also
    globus_gass_transfer_proto_new_request_t

  globus_gass_transfer_proto_new_attr_t globus_gass_transfer_proto_descriptor_t::new_requestattr
New request attributes.

The function pointed to by this pointer is used by GASS to forward requests to create a request attribute for this protocol's url_scheme to the protocol module. The function returns a request attribute which inherits from one of the GASS Transfer request attributes.

See also
    globus_gass_transfer_proto_new_attr_t

  char* globus_gass_transfer_proto_descriptor_t::url_scheme
URL Scheme.

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".

The GASS Transfer library allows only one protocol module to be registered to handle a particular url_scheme. 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.

Author

Generated automatically by Doxygen for globus_gass_transfer from the source code.