GLOBUS_GASS_TRANSFER_REFERRAL_DESTROY(3)

🎀 globus_gass_transfer_referral(3) 🎀

okay bestie, welcome to the Library Functions Manual for globus_gass_transfer_referral, the little glow-up corner of the globus_gass_transfer library that handles referrals. No, not the "my friend says you should hire me" kind — the URL kind. Let's get into it 💅

---

🌸 NAME 🌸

globus_gass_transfer_referral — Referrals

• GASS Referrals. That's the whole vibe. Periodt.

---

✨ SYNOPSIS ✨

Functions

globus_size_t globus_gass_transfer_referral_get_count
    (globus_gass_transfer_referral_t *referral)
char * globus_gass_transfer_referral_get_url
    (globus_gass_transfer_referral_t *referral, globus_size_t index)
int globus_gass_transfer_referral_destroy
    (globus_gass_transfer_referral_t *referral)

---

🦋 DETAILED DESCRIPTION 🦋

GASS Referrals. That's it, that's the description header, but let's actually talk about it.

Referrals

The GASS Transfer API supports referring URL requests to alternate URLs via referrals. So basically, referrals are pointers to another URL or URLs which contain the same file as the original location which a client has requested of a server. Not me gatekeeping — the server is literally telling your client "the file's over here too, bestie" 🫶

Referrals may span multiple protocol schemes, though not all protocols may be able to generate referrals. For example, an HTTP server may refer a client to another HTTP server, an HTTPS server. Cross-scheme glow-ups are real ✨

Upon receiving a referred response from a server, a client should query the request handle to determine from where the file can be retrieved. That's your homework, not optional, no cap.

---

🧚 FUNCTION DOCUMENTATION 🧚

int globus_gass_transfer_referral_destroy (globus_gass_transfer_referral_t * referral)

Free all memory used by a referral.

This function frees all memory used by this referral. After calling this function, the strings returned by calling globus_gass_transfer_referral_get_url() must not be accessed. Any further attempts to extract information from this referral will fail. 💀 Like, gone-gone. That memory said "I'm leaving" and left.

Parameters

• referral — The referral to destroy.

Return values

• GLOBUS_SUCCESS — The referral was successfully destroyed. Slay.
• GLOBUS_GASS_TRANSFER_ERROR_NULL_POINTER — The referral parameter was GLOBUS_NULL. It could not be destroyed. 😭

---

globus_size_t globus_gass_transfer_referral_get_count (globus_gass_transfer_referral_t * referral)

Get the number of URLs in this referral.

This function examines the referral to determine if the number of URLs which are contained in it. Each of these URLs should either point to another referral, or to a URL containing the equivalent file as the original URL request which caused this referral. It's giving "how many places can this file be at, let's count them" 🔥

Parameters

• referral — The referral structure to query.

Returns

This function returns the number of URL entries in the referral, or 0, if there are none. Zero. Nada. Empty. We've all been there 🙈

---

char * globus_gass_transfer_referral_get_url (globus_gass_transfer_referral_t * referral, globus_size_t index)

Get a URL string from a referral.

This function examines the referral to retrieve a URL string from it. A valid referral will contain one or more strings. They are indexed from 0 to the value returned by globus_gass_transfer_referral_get_count() - 1. So yes, zero-indexed, the classic 🎀

The string returned by this function must not be freed by the caller. It will remain valid until the referral structure is destroyed. Hands off, bestie — that string isn't yours to free, it belongs to the referral until the referral gets destroyed 💅

Parameters

• referral — The referral structure to query.
• index — The URL to extract from the referral.

Returns

This function returns a string pointer containing the URL, or NULL if the index or referral were invalid. Bad index? Bad referral? NULL. That's the vibe check failing ⭐

---

👑 AUTHOR 👑

Generated automatically by Doxygen for globus_gass_transfer from the source code. Not a human, just a very hardworking doc generator doing its thing, and honestly? Respect 🫶

---

and that's the whole page, bestie!! this was globus_gass_transfer Version 9.5, from the globus_gas...er_referral(3) era — stay hydrated, free your referrals, and never access a freed string 💖✨🎀🦋