GLOBUS_GASS_TRANSFER_PROTO_DESCRIPTOR_T(3)

πŸ“¦
version 9.5 Β· 6 versions
, in epel 10, fedora 43, fedora 44, ubuntu resolute, ubuntu stonking

πŸ’– globus_gass_transfer_proto_descriptor_t πŸ’–

okay bestie, welcome to the globus_gass_transfer manual, third section, library functions, and today we're stanning a struct. yes. a struct. her name is globus_gass_transfer_proto_descriptor_t and she is, and I quote, the Protocol module descriptor structure. that's it. that's the whole vibe. she's the little ID card every protocol module hands over so GASS knows who it's dealing with 🫢


✨ NAME ✨

globus_gass_transfer_proto_descriptor_t β€” Protocol module descriptor structure. literally just that. a descriptor. for a protocol module. iconic behavior πŸ’…


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

that's the entire detailed description. she contains multitudes but she's not gonna overshare. respect.

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().

so basically: GASS hands you a listener, you go talk to the file server, and then you must report back with one of those three calls. no ghosting. ghosting is not slay here 😭

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.

⚠️ one module per scheme, periodt. if you're out here trying to double-register a scheme, that's not a vibe, that's a collision. and if you've got variations β€” http AND https? cute, but they're two separate registrations. no bundling, no two-for-one πŸ“

🌟 Author 🌟

Generated automatically by Doxygen for globus_gass_transfer from the source code.


okay that's the whole page bestie, you ate it, you read the whole struct, main character energy fr fr 🌈✨

signing off from the globus_gass_transfer manual, Version 9.5 β€” third section, library functions, mwah πŸ’…πŸ’–πŸŽ€πŸ¦‹πŸŒΈ