GLOBUS_GASS_TRANSFER_PROTOCOL(3)

📦
version 9.5 · 7 versions
, in fedora 43, fedora 44, ubuntu resolute, ubuntu stonking

💖 globus_gass_transfer_protocol — Protocol Modules 💖

okay bestie, settle in, because this is the Library Functions Manual entry for section 3 and it's giving big energy. this is the Protocol Implementation API, and it's literally the blueprint for teaching GASS new tricks. no cap. 🦋

✨ NAME ✨

globus_gass_transfer_protocol — Protocol Modules

  • Protocol Implementation API. 🎀

🌸 SYNOPSIS 🌸

🧚 Data Structures

  • struct globus_gass_transfer_request_proto_s — Protocol module request handling structure. (the lil' request handler blueprint 💅)
  • struct globus_gass_transfer_listener_proto_s — Protocol module listener handling structure. (the listener handler blueprint 👑)
  • struct globus_gass_transfer_proto_descriptor_t — Protocol module descriptor structure. (the whole personality card of the module fr fr ⭐)

🎀 Typedefs

  • typedef struct globus_gass_transfer_request_proto_s globus_gass_transfer_request_proto_t
  • typedef struct globus_gass_transfer_listener_proto_s globus_gass_transfer_listener_proto_t
  • typedef void(* globus_gass_transfer_proto_send_t) (globus_gass_transfer_request_proto_t *proto, globus_gass_transfer_request_t request, globus_byte_t *bytes, globus_size_t bytes_length, globus_bool_t last_data)
  • typedef void(* globus_gass_transfer_proto_receive_t) (globus_gass_transfer_request_proto_t *proto, globus_gass_transfer_request_t request, globus_byte_t *bytes, globus_size_t bytes_length, globus_size_t wait_for_length)
  • typedef void(* globus_gass_transfer_proto_func_t) (globus_gass_transfer_request_proto_t *proto, globus_gass_transfer_request_t request)
  • typedef void(* globus_gass_transfer_proto_new_request_t) (globus_gass_transfer_request_t request, globus_gass_transfer_requestattr_t *attr)
  • typedef int(* globus_gass_transfer_proto_create_listener_t) (globus_gass_transfer_listener_t listener, globus_gass_transfer_listenerattr_t *attr, char *scheme, char **base_url, globus_gass_transfer_listener_proto_t **proto)
  • typedef void(* globus_gass_transfer_proto_listener_t) (globus_gass_transfer_listener_proto_t *proto, globus_gass_transfer_listener_t listener)
  • typedef globus_object_t *(* globus_gass_transfer_proto_new_attr_t) (char *url_scheme)
  • typedef void(* globus_gass_transfer_proto_accept_t) (globus_gass_transfer_listener_proto_t *proto, globus_gass_transfer_listener_t listener, globus_gass_transfer_request_t request, globus_gass_transfer_requestattr_t *attr)

🔥 Functions

  • void globus_gass_transfer_proto_send_complete (globus_gass_transfer_request_t request, globus_byte_t *bytes, globus_size_t nbytes, globus_bool_t failed, globus_bool_t last_data)
  • void globus_gass_transfer_proto_receive_complete (globus_gass_transfer_request_t request, globus_byte_t *bytes, globus_size_t nbytes, globus_bool_t failed, globus_bool_t last_data)
  • void globus_gass_transfer_proto_listener_ready (globus_gass_transfer_listener_t listener)
  • int globus_gass_transfer_proto_register_protocol (globus_gass_transfer_proto_descriptor_t *proto_desc)
  • int globus_gass_transfer_proto_unregister_protocol (globus_gass_transfer_proto_descriptor_t *proto_desc)
  • void globus_gass_transfer_proto_request_ready (globus_gass_transfer_request_t request, globus_gass_transfer_request_proto_t *proto)
  • void globus_gass_transfer_proto_new_listener_request (globus_gass_transfer_listener_t listener, globus_gass_transfer_request_t request, globus_gass_transfer_request_proto_t *proto)
  • void globus_gass_transfer_proto_request_denied (globus_gass_transfer_request_t request, int reason, char *message)
  • void globus_gass_transfer_proto_request_referred (globus_gass_transfer_request_t request, char **url, globus_size_t num_urls)

💜 Detailed Description 💜

Protocol Implementation API.

Protocol Modules

okay so here's the tea ☕ — the GASS Protocol Module API exists so you can extend the GASS client and server APIs to support extra protocols, and you never have to touch the core of the GASS implementation. not even once. that's the whole point, bestie. 🫶

GASS protocol modules are intended to handle protocol-specific connection and data handling. and get this — the GASS Transfer library already ships with protocol modules that implement HTTP, HTTPS, FTP, and GSI-FTP protocols. iconic lineup tbh. 👑

Every protocol module implementation must include the following header file:

#include "globus_gass_transfer_proto.h"

no exceptions, no skipping, that's the vibe check. ✅

so to implement a protocol module, you have to create a globus_gass_transfer_proto_descriptor_t structure, and this structure is literally the module's whole résumé — it says what the protocol module is able to do. it contains:

  • the URL scheme which the protocol module supports 🎀
  • function pointers which indicate what type of operations (client or server) that the module implements

now for the specifics, because details matter, periodt:

  • to implement a client-side protocol module, the new_requestattr and new_request fields must be set to the protocol module's implementations of those functions.
  • to implement a server-side</server-side> protocol module, the new_listenerattr and new_listener functions must be set to the protocol module's implementations of those functions.
💀 heads up bestie: the ordering here is not a drill. new_requestattr and new_request for client, new_listenerattr and new_listener for server. set them or your module is doing nothing.

A protocol module implementor registers a protocol module with the GASS Transfer library by calling the function globus_gass_transfer_proto_register_protocol(), and unregisters the module by calling globus_gass_transfer_proto_unregister_protocol().

⚠️ IMPORTANT, FR FR: these functions must be called after the GLOBUS_GASS_TRANSFER_MODULE has already been activated. like, activated first. do not come for the register-before-activate pipeline, it will not end well. 🙈

Once registered, applications may use URLs of the scheme type provided by the protocol module for the standard client or server operations. and that's the slay. ✨

✨ Typedef Documentation ✨

okay bestie, this is the typedef section and it is long but we are not skipping a single crumb 💅. every type, every param, every "see also" — it's all here. periodt.

globus_gass_transfer_listener_proto_t

typedef struct globus_gass_transfer_listener_proto_s globus_gass_transfer_listener_proto_t

it's the Protocol module listener handling structure ✨. that's the whole vibe.

See also: globus_gass_transfer_listener_proto_s

globus_gass_transfer_proto_accept_t

typedef void(* globus_gass_transfer_proto_accept_t)
       (globus_gass_transfer_listener_proto_t *proto,
       globus_gass_transfer_listener_t listener, globus_gass_transfer_request_t
       request, globus_gass_transfer_requestattr_t *attr)

Protocol module implementation function type for server request parsing 🫶.

function pointers of this type are linked up with the globus_gass_transfer_listener_proto_t that's associated with a particular listener handle. they get called when a server implementation wants to accept a new connection from the listener. a new request is generated based on the protocol-specific request done on the new connection. no cap.

the new request will be created with the attributes specified in the attr parameter. once the protocol module has parsed the request, it must call globus_gass_transfer_proto_new_listener_request() to let the server implementation decide how to process this request. like, that's not optional bestie 😭.

the protocol module should update the request to indicate the type of operation being requested, the size of the file (if applicable), and the identity of the client (if applicable).

Parameters:

  • proto — the protocol specific listener data structure associated with the listener handle.
  • listener — the listener handle which the user requested the listen on.
  • request — the new request handle.
  • attr — the request attribute set to be used when processing this request.

globus_gass_transfer_proto_create_listener_t

typedef int(* globus_gass_transfer_proto_create_listener_t)
       (globus_gass_transfer_listener_t listener,
       globus_gass_transfer_listenerattr_t *attr, char *scheme, char
       **base_url, globus_gass_transfer_listener_proto_t **proto)

Protocol module implementation function type for new server listeners 🌸.

a function pointer of this type is associated with the globus_gass_transfer_proto_descriptor_t for a particular protocol module's implementation. it gets called when the server has called globus_gass_transfer_create_listener(). iconic.

Parameters:

  • listener — the listener handle to associate with the new proto created by the protocol module.
  • attr — a protocol-specific attribute set, created by calling the protocol module's new_listenerattr function pointer.
  • scheme — the URL scheme that the server has requested for the new listener. this will be one the scheme associated with a particular protocol module.
  • base_url — a pointer to be set the value of the base url of this listener. for most protocols, this will contain the scheme, hostname, and port number of the listener. this string must be allocated using one of the memory allocators defined in the globus_common library. it will be freed by the GASS Transfer library when the listener is closed.
  • proto — a pointer to be set to a new globus_gass_transfer_listener_proto_t which will be associated with this listener. this must be allocated by the protocol module using one of the memory allocators defined in the globus_common library. it will be freed by the GASS Transfer library when the listener is closed.

Returns:

a GASS error value, or GLOBUS_SUCCESS. 💖

globus_gass_transfer_proto_func_t

typedef void(* globus_gass_transfer_proto_func_t)
       (globus_gass_transfer_request_proto_t *proto,
       globus_gass_transfer_request_t request)

Protocol module implementation function type 🦋.

function pointers of this type are associated with the globus_gass_transfer_request_proto_t associated with a particular request handle. they get called when certain functions which modify the status of a request have been called by a client or server.

a function of this type is used for the fail, deny, refer, authorize, and destroy fields of the globus_gass_transfer_request_proto_t. a protocol module can query the request handle to determine the status and, if applicable, denial reasons if necessary. iykyk.

Parameters:

  • proto — the protocol module's request handler.
  • request — the request handle.

globus_gass_transfer_proto_listener_t

typedef void(* globus_gass_transfer_proto_listener_t)
       (globus_gass_transfer_listener_proto_t *proto,
       globus_gass_transfer_listener_t listener)

Protocol module implementation function type for server operations 🍓.

function pointers of this type are associated with the globus_gass_transfer_listener_proto_t associated with a particular listener handle. they get called when a server implementation wants to close the listener, listen for new connections, or destroy the listener. slay.

Parameters:

  • proto — the protocol-specific implementation of the globus_gass_transfer_listener_proto_t for a particular listener.
  • listener — the listener handle associated with the proto.

See also: globus_gass_transfer_proto_create_listener_t

globus_gass_transfer_proto_new_attr_t

typedef globus_object_t *(* globus_gass_transfer_proto_new_attr_t) (char
       *url_scheme)

Protocol module implementation function type for attribute creation 🎀.

a function pointer of this type is associated with the globus_gass_transfer_proto_descriptor_t defining a protocol module. it gets called when a client requests a new request attribute set be created for a URL scheme handled by a protocol module. the function implementation must create a new request attribute usable by the protocol.

the returned attribute must be a globus object which inherits from one of the base attributes defined in the GASS Transfer API. a client or server operation will use a request attribute generated by this function when creating a new globus_gass_transfer_request_proto_t to handle a request. fr fr.

Parameters:

  • url_scheme — the URL scheme that the request attribute should be compatible with.

Returns:

a globus_object_t-based request attribute. 💅

See also: globus_gass_transfer_proto_new_request_t, globus_gass_transfer_proto_accept_t

globus_gass_transfer_proto_new_request_t

typedef void(* globus_gass_transfer_proto_new_request_t)
       (globus_gass_transfer_request_t request,
       globus_gass_transfer_requestattr_t *attr)

Protocol module implementation function type for new client requests ⭐.

a function pointer of this type is associated with the globus_gass_transfer_proto_descriptor_t for a particular protocol module's implementation. it gets called when the client has begun a file transfer request by calling one of the functions in the @ref globus_gass_transfer_client section of this manual.

when this function is called for a protocol module, the module should query the request handle to determine the URL which is being requested by the client, and the operation being done on that URL. the protocol module should initiate the request, and once it has determined that it has been authorized, denied, or referred, one of globus_gass_transfer_proto_request_ready(), globus_gass_transfer_proto_request_denied(), or globus_gass_transfer_proto_request_referred() must be called. like, you have to, bestie 😭.

Parameters:

  • request — the request handle containing the information about the request.
  • attr — a protocol-specific attribute set, created by calling the protocol module's new_requestattr function pointer.

globus_gass_transfer_proto_receive_t

typedef void(* globus_gass_transfer_proto_receive_t)
       (globus_gass_transfer_request_proto_t *proto,
       globus_gass_transfer_request_t request, globus_byte_t *bytes,
       globus_size_t bytes_length, globus_size_t wait_for_length)

Protocol module function type to handle receiving data 💙.

a function pointer of this type is associated with the globus_gass_transfer_request_proto_t associated with a request handle. it gets called when client or server has registered a bytes array for receiving from the client or server which is handling the request. the GASS Transfer Library will only pass one bytes array to the protocol module for processing per request at any given time.

once the protocol module has processed the array, it must call globus_gass_transfer_proto_receive_complete() to let the GASS Transfer library continue to process the request. no skipping that step, periodt.

Parameters:

  • proto — the protocol module's request handler.
  • request — the request handle with which this block of bytes is associated.
  • bytes — the user-supplied byte array containing the data associated with the request.
  • bytes_length — the length of the bytes array.
  • wait_for_length — the minimum amount of data to receive before calling globus_gass_transfer_proto_receive_complete() for the request. the GASS Transfer protocol module may call that function with a smaller value for the amount received if EOF has been reached.

See also: globus_gass_transfer_receive_bytes()

globus_gass_transfer_proto_send_t

typedef void(* globus_gass_transfer_proto_send_t)
       (globus_gass_transfer_request_proto_t *proto,
       globus_gass_transfer_request_t request, globus_byte_t *bytes,
       globus_size_t bytes_length, globus_bool_t last_data)

Protocol module function type to handle sending data 🌈.

a function pointer of this type is associated with the globus_gass_transfer_request_proto_t associated with a request handle. it gets called when client or server has registered a bytes array for sending to the client or server which is handling the request. the GASS Transfer Library will only pass one bytes array to the protocol module for processing per request at any given time.

once the protocol module has processed the array, it must call globus_gass_transfer_proto_send_complete() to let the GASS Transfer library continue to process the request. yes bestie, mandatory 💅.

Parameters:

  • proto — the protocol module's request handler.
  • request — the request handle with which this block of bytes is associated.
  • bytes — the user-supplied byte array containing the data associated with the request.
  • bytes_length — the length of the bytes array.
  • last_data — a flag to indicate whether this is the final block of data for the request. if this is true, then the callback function will be delayed until the server acknowledges that the file has been completely received.

See also: globus_gass_transfer_send_bytes()

globus_gass_transfer_request_proto_t

typedef struct globus_gass_transfer_request_proto_s globus_gass_transfer_request_proto_t

Protocol module request handling structure 👑. that's the whole mood.

See also: globus_gass_transfer_request_proto_s

💫 Function Documentation 💫

okay bestie, this is the big one — every single function a protocol module author gets to play with. these are the calls you (the protocol module) make to tell the GASS Transfer Library what's going on. no cap, this is the whole toolkit. 🧰✨

🌸 globus_gass_transfer_proto_listener_ready 🌸

void globus_gass_transfer_proto_listener_ready
    (globus_gass_transfer_listener_t listener)

Server listener ready. 💅

this one's your little "we're SO open for business" announcement. it tells the GASS Transfer Library that your protocol module has decided a brand new request can be accepted on this particular listener.

⚠️ lowkey important: you may only call this after the GASS Transfer Library has called the listen function inside a globus_gass_transfer_listener_proto_t protocol module-specific listener structure. don't jump the gun, bestie. 🙈

Parameters

  • listener — the listener handle that is now ready to accept a new connection. it's giving "door's open, come thru". 🚪

🦋 globus_gass_transfer_proto_new_listener_request 🦋

void globus_gass_transfer_proto_new_listener_request
    (globus_gass_transfer_listener_t listener,
     globus_gass_transfer_request_t request,
     globus_gass_transfer_request_proto_t * proto)

New listener request. ⭐

this is the "guess what, a new request just dropped" notification. it tells the GASS Transfer Library that a fresh request — born when a server called globus_gass_transfer_register_accept() — has started processing inside a protocol module, and that module is now ready to send or receive data to handle it. main character request energy, honestly. 👑

Parameters

  • listener — the listener handle that was used to accept this request.
  • request — the request handle used for this request. it was created when the user called one of the functions in the "@ref globus_gass_transfer_client" section of this manual. 🫶
  • proto — the protocol-module specific request structure. this lil guy holds a set of function pointers that let GASS keep processing the request. it's basically the roadmap. 🗺️

💜 globus_gass_transfer_proto_receive_complete 💜

void globus_gass_transfer_proto_receive_complete
    (globus_gass_transfer_request_t request,
     globus_byte_t * bytes,
     globus_size_t nbytes,
     globus_bool_t failed,
     globus_bool_t last_data)

Data receive complete. 📥✨

a protocol module must call this once a byte range that was registered for receive via the protocol module's recv_buffer method has been completely processed. and no, it's not picky — this one applies to protocol modules implementing either server or client functionality. everyone's invited to the party. 🎀

Parameters

  • request — the request handle associated with this byte array.
  • bytes — the byte array which was received into. this should be the same as the pointer passed in the send_buffer method.
  • nbytes — the number of bytes which were sent from this byte array. this may be different than the length passed to the send_buffer method if an error occurred or if EOF was reached while receiving the data. 😭
  • failed — a boolean saying whether this byte range was successfully received or not. set it to GLOBUS_TRUE if either a protocol error or a user-generated abort has occurred while processing the byte range. and if you set this to GLOBUS_TRUE, then the last_data parameter must also be set to GLOBUS_TRUE. them's the rules. 🚨
  • last_data — a boolean saying whether this byte range was the final one that can be processed for this request. set it to GLOBUS_TRUE if an error occurred while processing this byte range, a user-generated abort occurred, or this is the final byte range in the data transfer. 🏁

See also

  • globus_gass_transfer_send_bytes()

🌈 globus_gass_transfer_proto_register_protocol 🌈

int globus_gass_transfer_proto_register_protocol
    (globus_gass_transfer_proto_descriptor_t * proto_desc)

Register protocol. 📝

this is the "hey GASS, meet my protocol module" moment. it registers a protocol module handler with the GASS Transfer Library, and if it goes through, users of the library can use URLs with the protocol scheme your module descriptor implements in GASS Transfer operations. iconic. slay. 🔥

Parameters

  • proto_desc — the protocol module descriptor. peep the "@ref globus_gass_transfer_protocol" section of the manual for the deets on this structure. 👀

Return values

  • GLOBUS_SUCCESS — the protocol module was successfully registered with GASS. 🎉
  • GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER — the proto_desc parameter was GLOBUS_NULL. 💀
  • GLOBUS_GASS_TRANSFER_ERROR_ALREADY_REGISTERED — a protocol module has already been registered with GASS to handle this URL scheme. sorry babe, that seat's taken. 🙈

🍓 globus_gass_transfer_proto_request_denied 🍓

void globus_gass_transfer_proto_request_denied
    (globus_gass_transfer_request_t request,
     int reason,
     char * message)

Request denied. 🚫😭

the "it's not you, it's the server" call. this notifies the GASS Transfer Library that a new request — generated by a client calling one of the functions in the "@ref globus_gass_transfer_client" section of the manual — has been denied by the server, and so cannot be processed by the protocol module. rip to that request fr fr. 💀

Parameters

  • request — the request handle used for this request. this was created when the user called one of the functions in the "@ref globus_gass_transfer_client" section of this manual.
  • reason — a protocol-specific reason code.
  • message — a string containing a message describing why the request was denied. the GASS Transfer Library is responsible for freeing this message, so it must be allocated using one of the memory allocators defined in the Globus Common Library. don't just hand over a random stack buffer, bestie. 🫠

See also

  • globus_gass_transfer_proto_request_ready()
  • globus_gass_transfer_proto_request_referred()

✨ globus_gass_transfer_proto_request_ready ✨

void globus_gass_transfer_proto_request_ready
    (globus_gass_transfer_request_t request,
     globus_gass_transfer_request_proto_t * proto)

Request ready. ✅

the glow-up announcement: this tells the GASS Transfer Library that a new request generated by a client has begun processing in a protocol module, and that protocol module is now ready to send or receive data to handle this request. we love a prepared queen. 👑

Parameters

  • request — the request handle used for this request. this was created when the user called one of the functions in the "@ref globus_gass_transfer_client" section of this manual.
  • proto — the protocol-module specific request structure. it contains a set of function pointers to allow GASS to continue to process this request. the blueprint, basically. 🗺️

See also

  • globus_gass_transfer_proto_request_referred()
  • globus_gass_transfer_proto_request_denied()

🧚 globus_gass_transfer_proto_request_referred 🧚

void globus_gass_transfer_proto_request_referred
    (globus_gass_transfer_request_t request,
     char ** url,
     globus_size_t num_urls)

Request referred. 🔀

the "go ask them instead" energy. this notifies the GASS Transfer Library that a new request — generated by a client calling one of the functions in the "@ref globus_gass_transfer_client" section of the manual — has been referred to another URL by the server, so processing has stopped. it's giving "not here, try over there". 🫶

Parameters

  • request — the request handle used for this request. this was created when the user called one of the functions in the "@ref globus_gass_transfer_client" section of this manual.
  • url — an array of url strings containing alternate locations for this file. the GASS transfer library is responsible for freeing this array, so it must be allocated using one of the memory allocators defined in the Globus Common Library. 📌
  • num_urls — the length of the url array.

See also

  • globus_gass_transfer_proto_request_ready()
  • globus_gass_transfer_proto_request_denied()
  • globus_gass_transfer_proto_request_referred()

💅 globus_gass_transfer_proto_send_complete 💅

void globus_gass_transfer_proto_send_complete
    (globus_gass_transfer_request_t request,
     globus_byte_t * bytes,
     globus_size_t nbytes,
     globus_bool_t failed,
     globus_bool_t last_data)

Data send complete. 📤✨

a protocol module must call this once a byte range registered for sending via the protocol module's send_buffer method has been completely processed. and again — this applies to protocol modules implementing either server or client functionality. equal opportunity completion. 🌈

Parameters

  • request — the request handle associated with this byte array.
  • bytes — the byte array which was sent. this should be the same as the pointer passed in the send_buffer method.
  • nbytes — the number of bytes which were sent from this byte array. this may be different than the length passed to the send_buffer method if an error occurred. 😭
  • failed — a boolean saying whether this byte range was successfully sent or not. set it to GLOBUS_TRUE if either a protocol error or a user-generated abort has occurred while processing the byte range. and if you set this to GLOBUS_TRUE, then the last_data parameter must also be set to GLOBUS_TRUE. same deal as before, bestie. 🚨
  • last_data — a boolean saying whether this byte range was the final one that can be processed for this request. set it to GLOBUS_TRUE if an error occurred while processing this byte range, a user-generated abort occurred, or this is the final byte range in the data transfer. 🏁

See also

  • globus_gass_transfer_send_bytes()

👑 globus_gass_transfer_proto_unregister_protocol 👑

int globus_gass_transfer_proto_unregister_protocol
    (globus_gass_transfer_proto_descriptor_t * proto_desc)

Unregister protocol. 🗑️

the "we're breaking up, respectfully" call. this unregisters a protocol module handler from the GASS Transfer Library. if it succeeds, then users of the library may no longer use URLs with the protocol scheme implemented by this module descriptor in GASS Transfer operations. it's over, no hard feelings. 💔

Parameters

  • proto_desc — the protocol module descriptor. check the "@ref globus_gass_transfer_protocol" section of the manual for the info on this structure. 👀

Return values

  • GLOBUS_SUCCESS — the protocol module was successfully registered with GASS.
  • GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER — the proto_desc parameter was GLOBUS_NULL. 💀
  • GLOBUS_GASS_TRANSFER_ERROR_INVALID_USE — a protocol module has not been registered with GASS to handle this URL scheme. you can't un-register something that was never registered, babe. 🙈

📜 Author 📜

Generated automatically by Doxygen for globus_gass_transfer from the source code. it wrote itself, literally. 🤖✨

and that's a wrap on the whole page, bestie!! 🎀🫶 you made it all the way through — every listener, every request, every GLOBUS_TRUE, every single byte. if you ever forget a function, just come back and vibe-check this manual. the footer's got the receipts too: this is Version 9.5 of globus_gass_transfer, and the page goes by globus_gas...er_protocol(3), with its date stamp sitting right there at the bottom where it belongs. now go write a protocol module, you absolute icon. 💖 slay. periodt. 👑🌸

📦 where this page comes from