globus_sch...erator_api(3)

💖 NAME 💖

globus_scheduler_event_generator_api — Scheduler Implementation API ✨

ok bestie, this is the manual for globus_sch...erator_api(3) and it's literally all about how a SEG module (scheduler-specific) gets to spill the tea to the Job State Monitor. no cap.

---

✨ SYNOPSIS ✨

Enumerations

enum globus_scheduler_event_generator_error_t {
    GLOBUS_SEG_ERROR_TYPE_NULL = 1024,
    GLOBUS_SEG_ERROR_TYPE_ALREADY_SET,
    GLOBUS_SEG_ERROR_TYPE_INVALID_MODULE,
    GLOBUS_SEG_ERROR_TYPE_INVALID_FORMAT,
    GLOBUS_SEG_ERROR_TYPE_OUT_OF_MEMORY,
    GLOBUS_SEG_ERROR_TYPE_LOADING_MODULE
}

---

🌸 DETAILED DESCRIPTION 🌸

Scheduler Implementation API. 💅

Scheduler-specific SEG module implementations use this API to issue events to the Job State Monitor. and the events fire whenever a job:

• gets placed in the scheduler's queue (PENDING) 🕐
• begins execution (ACTIVE) 🔥
• terminates successfully (DONE) ✅
• or ends abnormally (FAILED) 💀

so basically the whole job lifecycle, main character energy from start to finish.

A SEG module should register an event with the Globus event driver (most likely using either the Globus Callback or Globus XIO interfaces) in its activation function and then return. 🫶

and listen — all events should be triggered from callbacks. not vibes, not guesses. callbacks.

When the SEG detects that it should terminate, it will deactivate the SEG module it started. The SEG module should wait for any outstanding callbacks to subside and before returning from its deactivation function to ensure that all events will be properly dispatched. After deactivation is complete, the SEG will unload the shared module and terminate. 🧚

like, don't ghost your callbacks mid-flight, that's so not the move.

---

🎀 ENUMERATION TYPE DOCUMENTATION 🎀

enum globus_scheduler_event_generator_error_t

Error types used by the SEG. 😭 iconic error catalogue fr fr.

Enumerator

• GLOBUS_SEG_ERROR_TYPE_NULL — NULL Parameter
• GLOBUS_SEG_ERROR_TYPE_ALREADY_SET — Already called a one-time function
• GLOBUS_SEG_ERROR_TYPE_INVALID_MODULE — Shared module missing descriptor
• GLOBUS_SEG_ERROR_TYPE_INVALID_FORMAT — Invalid printf format for SEG protocol message
• GLOBUS_SEG_ERROR_TYPE_OUT_OF_MEMORY — Out of memory
• GLOBUS_SEG_ERROR_TYPE_LOADING_MODULE — Unable to load scheduler module

---

👑 AUTHOR 👑

Generated automatically by Doxygen for globus_scheduler_event_generator from the source code. 🤖✨

---

k that's the whole page bestie, slay. this came from globus_scheduler_event_generator, Version 6.6, and it's filed under globus_sch...erator_api(3). go forth and dispatch your events properly 💖🌈🦋