globus_gas...er_proto.h(3)

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

πŸ’– globus_gass_transfer_proto.h β€” GASS Transfer Protocol Interface πŸ’–

okay bestie, welcome to the Library Functions Manual page for globus_gass_transfer_proto.h(3) β€” yes the header is literally globus_gas...er_proto.h(3) because the terminal is a little dramatic and truncates things, we love that for it πŸ’…


🌸 NAME 🌸

globus_gass_transfer_proto.h β€” the GASS Transfer Protocol Interface. that's it, that's the name, slay.


✨ SYNOPSIS ✨

#include 'globus_common.h'
#include 'globus_gass_transfer.h'

(yes those are single quotes, that's how Doxygen wrote them, we do not touch, we do not editorialize, periodt πŸŽ€)


πŸ¦‹ Data Structures πŸ¦‹

  • struct globus_gass_transfer_request_proto_s β€” the protocol module's request handling structure. it's giving "I handle requests."
  • struct globus_gass_transfer_listener_proto_s β€” the protocol module's listener handling structure. it listens. iconic behavior.
  • struct globus_gass_transfer_proto_descriptor_t β€” the protocol module's descriptor structure. the blueprint, the moment, the vibe.

🧚 Typedefs 🧚

bestie there are SO many of these and every single one is staying, no skips, no cuts, we're finishing the whole plate πŸ“

  • globus_gass_transfer_request_proto_t β€” a typedef for struct globus_gass_transfer_request_proto_s.
typedef struct globus_gass_transfer_request_proto_s
    globus_gass_transfer_request_proto_t
  • globus_gass_transfer_listener_proto_t β€” a typedef for struct globus_gass_transfer_listener_proto_s.
typedef struct globus_gass_transfer_listener_proto_s
    globus_gass_transfer_listener_proto_t
  • globus_gass_transfer_proto_send_t β€” a function pointer type, void(*)(...), that takes a globus_gass_transfer_request_proto_t *proto, a globus_gass_transfer_request_t request, a globus_byte_t *bytes, a globus_size_t bytes_length, and a globus_bool_t last_data. it sends. it's the sender. no cap.
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)
  • globus_gass_transfer_proto_receive_t β€” another void(*)(...) pointer, this one taking globus_gass_transfer_request_proto_t *proto, globus_gass_transfer_request_t request, globus_byte_t *bytes, globus_size_t bytes_length, and globus_size_t wait_for_length. the receiving counterpart, the other half of the ship 🫢
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)
  • globus_gass_transfer_proto_func_t β€” void(*)(...) taking globus_gass_transfer_request_proto_t *proto and globus_gass_transfer_request_t request. the generic little guy of the bunch ✨
typedef void(* globus_gass_transfer_proto_func_t)
    (globus_gass_transfer_request_proto_t *proto,
    globus_gass_transfer_request_t request)
  • globus_gass_transfer_proto_new_request_t β€” void(*)(...) taking globus_gass_transfer_request_t request and globus_gass_transfer_requestattr_t *attr. it's the "new request just dropped" callback πŸ’…
typedef void(* globus_gass_transfer_proto_new_request_t)
    (globus_gass_transfer_request_t request,
    globus_gass_transfer_requestattr_t *attr)
  • globus_gass_transfer_proto_create_listener_t β€” this one returns int, and it's a whole squad of params: globus_gass_transfer_listener_t listener, globus_gass_transfer_listenerattr_t *attr, char *scheme, char **base_url, and globus_gass_transfer_listener_proto_t **proto. main character energy fr fr πŸ‘‘
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)
  • globus_gass_transfer_proto_listener_t β€” void(*)(...) taking globus_gass_transfer_listener_proto_t *proto and globus_gass_transfer_listener_t listener. the listener callback, doing its little listener thing 🌈
typedef void(* globus_gass_transfer_proto_listener_t)
    (globus_gass_transfer_listener_proto_t *proto,
    globus_gass_transfer_listener_t listener)
  • globus_gass_transfer_proto_new_attr_t β€” returns a globus_object_t * and takes a single char *url_scheme. one param, one pointer, simple life, we respect it πŸ’œ
typedef globus_object_t *(* globus_gass_transfer_proto_new_attr_t) (char
    *url_scheme)
  • globus_gass_transfer_proto_accept_t β€” void(*)(...) taking globus_gass_transfer_listener_proto_t *proto, globus_gass_transfer_listener_t listener, globus_gass_transfer_request_t request, and globus_gass_transfer_requestattr_t *attr. the accepter, the yes-sayer, we stan πŸŽ€
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)

πŸ”₯ Detailed Description πŸ”₯

okay so the GASS Transfer Protocol Interface β€” that's the vibe, that's the whole point of this header.

this header defines the GASS protocol module library interface. literally what it says on the tin, and the tin is shiny ✨


πŸ’€ Author πŸ’€

Generated automatically by Doxygen for globus_gass_transfer from the source code. (not me writing this by hand, the robot did it, and honestly? it ate.)


and that's the whole page bestie, every struct, every typedef, every param, nothing skipped, nothing invented, iykyk πŸ¦‹

later babe β€” this was globus_gass_transfer Version 9.5, signing off from the globus_gas...er_proto.h(3) page πŸ’–πŸ«Άβœ¨