GLOBUS_GRAM_PROTOCOL_ERROR_STRING(3)

✨ globus_gra...or_messages(3) — Library Functions Manual ✨

okay bestie, welcome to the error-message corner of globus_gram_protocol 💅 this one lives in the Library Functions Manual, and it's all about turning sad little GRAM error numbers into actual sentences you can read. let's go 🦋

---

🌸 NAME 🌸

globus_gram_protocol_error_messages — Error Messages

• GRAM Error Messages. that's it, that's the whole vibe ✨

---

🎀 SYNOPSIS 🎀

Functions

const char * globus_gram_protocol_error_string (int error_code)

Get a description of a a GRAM error code. (yes, the double "a a" is canon, we don't touch the source text's little quirks, we just appreciate them 🙈)

void globus_gram_protocol_error_7_hack_replace_message (const char *message)

Replace the error message associated with error 7 with a custom message.

void globus_gram_protocol_error_10_hack_replace_message (const char *message)

Replace the error message associated with error 10 with a custom message.

---

💖 Detailed Description 💖

GRAM Error Messages.

The functions in this section handle converting GRAM error codes to strings, which can help the user diagnose GRAM problems. it's giving "translator for your error codes" and honestly? iconic 👑

---

🌈 Function Documentation 🌈

💅 void globus_gram_protocol_error_10_hack_replace_message (const char * message)

Replace the error message associated with error 10 with a custom message.

So here's the tea: globus_gram_protocol_error_10_hack_replace_message() makes a custom version of the error message for the error GLOBUS_GRAM_PROTOCOL_ERROR_PROTOCOL_FAILED. The string that message points to gets copied to thread-local storage, and every subsequent call to globus_gram_protocol_error_string() with this error number will hand you back this copy of the string. and not me telling you that each time globus_gram_protocol_error_10_hack_replace_message() is called for a particular thread, the previous message is freed 💀 so like, don't hold onto the old one, she's gone.

The purpose of this function is to allow more meaningful error messages to be generated when protocol errors occur. In particular, the specific XIO error reason can be used in place of a generic protocol failure message. lowkey genius fr fr.

Parameters

• message — The new message to be associated with the GLOBUS_GRAM_PROTOCOL_ERROR_PROTOCOL_FAILED error code.

Note 🫶 Since Globus 5.0.0, this function uses thread-specific storage, so that the value returned by globus_gram_protocol_error_string() for GLOBUS_GRAM_PROTOCOL_ERROR_PROTOCOL_FAILED is that for the last authorization error where globus_gram_protocol_error_10_hack_replace_message() was called from this thread.

---

🌸 void globus_gram_protocol_error_7_hack_replace_message (const char * message)

Replace the error message associated with error 7 with a custom message.

globus_gram_protocol_error_7_hack_replace_message() creates a custom version of the error message for the error GLOBUS_GRAM_PROTOCOL_ERROR_AUTHORIZATION. The string pointed to by the message parameter is copied to thread-local storage, and subsequent calls to globus_gram_protocol_error_string() with this error number will return this copy of the string. Each time globus_gram_protocol_error_7_hack_replace_message() is called for a particular thread, the previous message is freed. same energy as the error-10 one, just different error number, bestie 🦋

The purpose of this function is to allow more meaningful error messages to be generated when authentication failures occur. In particular, the specific GSSAPI error reason can be used in place of a generic authorization failure message. so real of them.

Parameters

• message — The new message to be associated with the GLOBUS_GRAM_PROTOCOL_ERROR_AUTHORIZATION error code.

Note 💜 Since Globus 5.0.0, this function uses thread-specific storage, so that the value returned by globus_gram_protocol_error_string() for GLOBUS_GRAM_PROTOCOL_ERROR_AUTHORIZATION is that for the last authorization error where globus_gram_protocol_error_7_hack_replace_message() was called from this thread.

---

⭐ const char * globus_gram_protocol_error_string (int error_code)

Get a description of a a GRAM error code.

The globus_gram_protocol_error_string() function takes a GRAM error code value and returns the associated error code string for the message. The string is statically allocated by the GRAM Protocol library and should not be modified or freed by the caller — hands off, no touchy, she's not yours 🙈 The string is intended to complete a sentence of the form "[operation] failed because ..." which is honestly such a dramatic way to structure a sentence and I respect it deeply.

Parameters

• error_code — The error code to translate into a string.

Returns

The globus_gram_protocol_error_string() function returns a static string containing an explanation of the error. periodt ✨

---

👑 Author 👑

Generated automatically by Doxygen for globus_gram_protocol from the source code. (not a human author, a robot author, and she ate 💅)

---

and that's the whole page bestie!! 🎀 this one shipped as globus_gram_protocol, Version 13.6 — so if you're quoting it in the group chat, that's the version tag, no cap. stay slaying those error codes, mwah 💖🦋🌸