globus_callback(3)

✨ globus_callback ✨

okay bestie, welcome to Globus Callback 💖 this is from the Library Functions Manual, and it's literally the Globus Callback Function Interface. yes that's a lot of "callback" in one sentence. we move.

---

🌸 SYNOPSIS 🌸

🎀 Topics

• Globus Callback API — the Globus Callback API, bestie.
• Globus Callback Spaces — Globus Callback Spaces.
• Globus Callback Signal Handling — Globus Callback Signal Handling.

🎀 Macros

• #define GLOBUS_CALLBACK_MODULE — Module descriptor.
• #define GLOBUS_POLL_MODULE — Module descriptor.

🎀 Typedefs

• typedef int globus_callback_handle_t — Periodic callback handle.
• typedef int globus_callback_space_t — Callback space handle.
• typedef struct globus_l_callback_space_attr_s * globus_callback_space_attr_t — Callback space attribute.

🎀 Enumerations

• enum globus_callback_error_type_t { — Error types.

GLOBUS_CALLBACK_ERROR_INVALID_CALLBACK_HANDLE = 1024,
GLOBUS_CALLBACK_ERROR_INVALID_SPACE,
GLOBUS_CALLBACK_ERROR_MEMORY_ALLOC,
GLOBUS_CALLBACK_ERROR_INVALID_ARGUMENT,
GLOBUS_CALLBACK_ERROR_ALREADY_CANCELED,
GLOBUS_CALLBACK_ERROR_NO_ACTIVE_CALLBACK }

---

💅 Detailed Description 💅

Globus Callback Function Interface. that's the whole vibe. slay.

---

🦋 Macro Definition Documentation 🦋

🌟 #define GLOBUS_CALLBACK_MODULE

Module descriptor. it's the module descriptor for the globus_callback module, bestie. you must activate it before you call any of the api below. no skipping steps, fr fr.

Note: you would not normally activate this module directly. activating the GLOBUS_COMMON_MODULE will in turn activate this one too. so like… it handles it for you. iconic behaviour honestly.

🌟 #define GLOBUS_POLL_MODULE

Module descriptor.

Deprecated — it's a backward compatible name. yes bestie, deprecated. it still works but the way it's giving legacy 😭

---

💜 Typedef Documentation 💜

🌟 typedef int globus_callback_handle_t

Periodic callback handle. you can copy it, you can compare it, and you can represent it as NULL with GLOBUS_NULL_HANDLE. easy peasy 🍓

🌟 typedef struct globus_l_callback_space_attr_s* globus_callback_space_attr_t

Callback space attribute. this handle can be copied, and you represent it as NULL with GLOBUS_NULL. that's it, that's the whole thing ✨

🌟 typedef int globus_callback_space_t

Callback space handle. copy it, compare it, and represent it as NULL with GLOBUS_NULL_HANDLE. same energy as the other handle, honestly 👑

---

🌈 Enumeration Type Documentation 🌈

🌟 enum globus_callback_error_type_t

Error types. these are the possible error types the api in this module returns, and you can use the error API to check your results against them. so handy.

See also: Error Handling Helpers

🧚 Enumerator 🧚

• GLOBUS_CALLBACK_ERROR_INVALID_CALLBACK_HANDLE — the callback handle is not valid, or it has already been destroyed 💀
• GLOBUS_CALLBACK_ERROR_INVALID_SPACE — the space handle is not valid, or it has already been destroyed 💀
• GLOBUS_CALLBACK_ERROR_MEMORY_ALLOC — could not allocate memory for an internal structure 😭
• GLOBUS_CALLBACK_ERROR_INVALID_ARGUMENT — one of the arguments is NULL or out of range 🙈
• GLOBUS_CALLBACK_ERROR_ALREADY_CANCELED — attempt to unregister callback again 🙃
• GLOBUS_CALLBACK_ERROR_NO_ACTIVE_CALLBACK — attempt to retrieve info about a callback not in caller's stack 🫠

---

👑 Author 👑

Generated automatically by Doxygen for globus_common from the source code. the robot did the writing, we just did the vibes 💖

---

okay that's the whole page bestie, and for the cute sign-off: this is from globus_common, Version 18.15, dated as globus_callback(3) — periodt, that's the page number too 🌸✨🫶