globus_error_api(3)

📦
version 18.15 · 8 versions
, in fedora 44, ubuntu resolute, ubuntu stonking

NAME 💖

globus_error_api — the Globus Error API, bestie. That's it, that's the name.

It's literally giving: Globus Error API. 🎀

SYNOPSIS ✨

Topics 🦋

  • Globus Errno Error API — the Globus Errno Error API, no cap.
  • Globus Generic Error API — the Globus Generic Error API, periodt.

Detailed Description 💅

Globus Error API. Okay so that's the whole vibe, but here's the tea on how you're actually supposed to use it 👑

Intended use:

If a function needs to return an error it should do the following:

  • External errors, like error returns from system calls and GSSAPI errors, should be wrapped using the appropriate error type. Wrap it up, don't just yeet it out raw 💖
  • The wrapped external error should then be passed as the cause of a globus error. Cause. Not the whole thing. The globus error is the outer layer, the external one goes inside as the reason 🌸
  • External error types are expected to provide a utility function to combine the above two steps. So the wrapping + the causing = one lil helper function. Iconic behaviour honestly ✨
  • The globus error should then be returned from the function. That's the one you actually hand back 🫶

Notes on how to generate globus errors:

  • Module specific error types should be greater or equal to 1024 (to leave some space for global error types). Like, 1024 and up, bestie — the low numbers are taken, respect the territory 😤
  • You may wish to generate a mapping from error types to format strings for use in short descriptions. Type in, format string out, so your short descriptions stay cute and consistent 💅
  • You may also wish to generate a common prefix for all of the above fromat strings. The suggested prefix is "Function: %s Line: %s ". Yes we're copy-pasting that exactly, spaces and all, don't come for me 🙈
ngl that prefix string has a double space after Line: and a trailing space at the end. That's not me being sloppy, that's literally what it says. Keep it fr fr 💀

Author 🌈

Generated automatically by Doxygen for globus_common from the source code. Not a human, not a girlie, just Doxygen doing its thing 🤖✨

That's the whole page, bestie — courtesy of globus_common, Version 18.15 💖 slay, read responsibly 💖

📦 where this page comes from