builtins/m...e_driver.h(3)

💖 builtins/mode_e/globus_xio_mode_e_driver.h 💖

okay bestie, welcome to the XIO MODE_E Driver — yes that's the real name, it lives in builtins/m...e_driver.h(3), and it's a Library Functions Manual situation, so like, C header energy, you know? 🦋 pull up a chair, we're reading a manpage together and honestly? it's giving iconic. ✨

---

🌸 NAME 🌸

builtins/mode_e/globus_xio_mode_e_driver.h — the XIO MODE_E Driver. that's it, that's the name, she's simple, she's elegant, she's her. 💅

---

✨ SYNOPSIS ✨

first things first, you gotta include her:

#include 'globus_common.h'

(yeah bestie, it's single quotes up in there, that's how it's written, we don't question the ancestors, we just copy it exactly 🫶)

🎀 Enumerations 🎀

not one but two enums, because why have one when you can have two, main character behaviour fr:

• enum globus_xio_mode_e_error_type_t — with exactly one (1) value, and she's the whole squad:
  • GLOBUS_XIO_MODE_E_HEADER_ERROR
• enum globus_xio_mode_e_cmd_t — the big one, the group chat, the full roster of commands:
  • GLOBUS_XIO_MODE_E_SET_STACK
  • GLOBUS_XIO_MODE_E_GET_STACK
  • GLOBUS_XIO_MODE_E_SET_NUM_STREAMS
  • GLOBUS_XIO_MODE_E_GET_NUM_STREAMS
  • GLOBUS_XIO_MODE_E_SET_OFFSET_READS
  • GLOBUS_XIO_MODE_E_GET_OFFSET_READS
  • GLOBUS_XIO_MODE_E_SET_MANUAL_EODC
  • GLOBUS_XIO_MODE_E_GET_MANUAL_EODC
  • GLOBUS_XIO_MODE_E_SEND_EOD
  • GLOBUS_XIO_MODE_E_SET_EODC
  • GLOBUS_XIO_MODE_E_DD_GET_OFFSET
  • GLOBUS_XIO_MODE_E_SET_STACK_ATTR
  • GLOBUS_XIO_MODE_E_GET_STACK_ATTR

🌈 Functions 🌈

okay so these are all the calls, and notice how the same function name keeps showing up wearing different outfits — she contains multitudes, she's globus_xio_attr_cntl, she's globus_xio_data_descriptor_cntl, she's globus_xio_handle_cntl, and every single one of them returns a globus_result_t. no cap. 💯

globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_MODE_E_SET_STACK, globus_xio_stack_t stack)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_MODE_E_GET_STACK, globus_xio_stack_t *stack_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_MODE_E_SET_NUM_STREAMS, int num_streams)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_MODE_E_GET_NUM_STREAMS, int *num_streams_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_MODE_E_SET_OFFSET_READS, globus_bool_t offset_reads)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_MODE_E_GET_OFFSET_READS, globus_bool_t *offset_reads_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_MODE_E_SET_MANUAL_EODC, globus_bool_t manual_eodc)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_MODE_E_GET_MANUAL_EODC, globus_bool_t *manual_eodc_out)
globus_result_t globus_xio_data_descriptor_cntl (dd, driver,
    GLOBUS_XIO_MODE_E_SEND_EOD, globus_bool_t send_eod)
globus_result_t globus_xio_handle_cntl (handle, driver,
    GLOBUS_XIO_MODE_E_SET_EODC, int eod_count)
globus_result_t globus_xio_data_descriptor_cntl (dd, driver,
    GLOBUS_XIO_MODE_E_DD_GET_OFFSET, globus_off_t *offset_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_MODE_E_SET_STACK_ATTR, globus_xio_stack_t stack)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_MODE_E_GET_STACK_ATTR, globus_xio_attr_t *stack_out)

literally thirteen of them. count them. I did. thirteen. 🔥

side note bestie: the *_out ones hand you a pointer so the value can come back out to you, and the plain ones take the value right there. the SETs go in, the GETs come out, that's the vibe, iykyk. 🧚

---

👑 Detailed Description 👑

XIO MODE_E Driver.

that's the whole description. short. mysterious. understated. she said "figure me out" and honestly? valid. 💜

---

🦋 Author 🦋

Generated automatically by Doxygen for globus_xio from the source code. so like, a robot wrote this, but a robot with taste. 🙈

---

aaaaand that's the page bestie, you ate, I ate, we all ate. 🍓

kisses and semicolons, mwah 💖

this has been globus_xio — Version 6.6 — builtins/m...e_driver.h(3) periodt ✨💅🎀