builtins/o...g_driver.h(3)

📦
version 6.6 · 5 versions
, in epel 10, fedora 43, fedora 44, ubuntu resolute, ubuntu stonking

💖 builtins/o...g_driver.h(3) — the XIO ORDERING Driver, bestie edition 💖

okay so. this page lives in the Library Functions Manual, section 3, and it's filed under the extremely mysterious name builtins/o...g_driver.h (yes the ... is literally in there, don't @ me, that's just what the file is called). it's giving "the header that runs the whole ordering situation" and honestly? iconic. let's get into it 🫶

✨ NAME ✨

builtins/ordering/globus_xio_ordering_driver.h — XIO ORDERING Driver. that's it, that's the whole name section. short, sweet, slay. 💅

🌸 SYNOPSIS 🌸

first thing you do, every time, no exceptions:

#include 'globus_common.h'

(yes, with the single quotes exactly like that. we don't question it, we just include it 💀)

🎀 Enumerations

two enums, both absolute main characters:

  • enum globus_xio_ordering_error_type_t — the error vibe check. its members are:
    • GLOBUS_XIO_ORDERING_ERROR_READ
    • GLOBUS_XIO_ORDERING_ERROR_CANCEL
  • enum globus_xio_ordering_cmd_t — the whole command menu, the order-in-which-you-do-things lineup:
    • GLOBUS_XIO_ORDERING_SET_OFFSET
    • GLOBUS_XIO_ORDERING_SET_MAX_READ_COUNT
    • GLOBUS_XIO_ORDERING_GET_MAX_READ_COUNT
    • GLOBUS_XIO_ORDERING_SET_BUFFERING
    • GLOBUS_XIO_ORDERING_GET_BUFFERING
    • GLOBUS_XIO_ORDERING_SET_BUF_SIZE
    • GLOBUS_XIO_ORDERING_GET_BUF_SIZE
    • GLOBUS_XIO_ORDERING_SET_MAX_BUF_COUNT
    • GLOBUS_XIO_ORDERING_GET_MAX_BUF_COUNT

🦋 Functions

nine functions, all returning globus_result_t, all routed through globus_xio_handle_cntl or globus_xio_attr_cntl. copy these exactly, bestie, character for character:

globus_result_t globus_xio_handle_cntl (handle, driver,
    GLOBUS_XIO_ORDERING_SET_OFFSET, globus_off_t offset)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_ORDERING_SET_MAX_READ_COUNT, int max_read_count)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_ORDERING_GET_MAX_READ_COUNT, int *max_read_count_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_ORDERING_SET_BUFFERING, globus_bool_t buffering)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_ORDERING_GET_BUFFERING, globus_bool_t *buffering_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_ORDERING_SET_BUF_SIZE, int buf_size)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_ORDERING_GET_BUF_SIZE, int *buf_size_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_ORDERING_SET_MAX_BUF_COUNT, int max_buf_count)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_ORDERING_GET_MAX_BUF_COUNT, int *max_buf_count_out)

see the pattern? SET takes the value, GET takes a pointer to write the value back into. the *_out ones are literally holding the receipts for you. 🧚

💜 Detailed Description 💜

XIO ORDERING Driver.

that's the whole detailed description. the original really said "the driver is the driver" and moved on. respect the brevity honestly, it's a whole mood. 🌈

👑 Author 👑

Generated automatically by Doxygen for globus_xio from the source code.

so nobody hand-wrote this, a robot did, and the robot ate. periodt. 🤖✨

aaaand that's the whole page bestie!! no cap, every flag, every enum member, every function signature is right here — nothing skipped, nothing added, just the facts wrapped in sparkles. 💖

signing off: this page comes from globus_xio, Version 6.6, and it's filed under builtins/o...g_driver.h(3). stay ordered out there, babe 🎀🦋💅

📦 where this page comes from