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

💖 builtins/f...e_driver.h(3) — the XIO File Driver, bestie edition 💖

okay so this is a page from the Library Functions Manual, and it's literally all about builtins/file/globus_xio_file_driver.h, aka the XIO File Driver. sit down, hydrate, and let's get into it 🫶

---

✨ NAME ✨

builtins/file/globus_xio_file_driver.h — XIO File Driver. that's it, that's the name, iconic 💅

---

🌸 SYNOPSIS 🌸

#include 'globus_xio_system.h'

ngl bestie, that include is written exactly like that in the original — single quotes and all. don't come for me, I just work here 😭

🎀 Macros 🎀

• #define GLOBUS_XIO_FILE_INVALID_HANDLE — the "this handle is not it" sentinel, no further details given, she's mysterious like that ✨

🦋 Enumerations 🦋

• enum globus_xio_file_attr_cmd_t { GLOBUS_XIO_FILE_SET_MODE, GLOBUS_XIO_FILE_GET_MODE, GLOBUS_XIO_FILE_SET_FLAGS, GLOBUS_XIO_FILE_GET_FLAGS, GLOBUS_XIO_FILE_SET_TRUNC_OFFSET, GLOBUS_XIO_FILE_GET_TRUNC_OFFSET, GLOBUS_XIO_FILE_SET_HANDLE, GLOBUS_XIO_FILE_GET_HANDLE, GLOBUS_XIO_FILE_SET_BLOCKING_IO, GLOBUS_XIO_FILE_GET_BLOCKING_IO, GLOBUS_XIO_FILE_SEEK }
• enum globus_xio_file_flag_t { GLOBUS_XIO_FILE_CREAT = O_CREAT, GLOBUS_XIO_FILE_EXCL = O_EXCL, GLOBUS_XIO_FILE_RDONLY = O_RDONLY, GLOBUS_XIO_FILE_WRONLY = O_WRONLY, GLOBUS_XIO_FILE_RDWR = O_RDWR, GLOBUS_XIO_FILE_TRUNC = O_TRUNC, GLOBUS_XIO_FILE_APPEND = O_APPEND, GLOBUS_XIO_FILE_BINARY = 0, GLOBUS_XIO_FILE_TEXT = 0 }
• enum globus_xio_file_mode_t { GLOBUS_XIO_FILE_IRWXU = S_IRWXU, GLOBUS_XIO_FILE_IRUSR = S_IRUSR, GLOBUS_XIO_FILE_IWUSR = S_IWUSR, GLOBUS_XIO_FILE_IXUSR = S_IXUSR, GLOBUS_XIO_FILE_IRWXO = S_IRWXO, GLOBUS_XIO_FILE_IROTH = S_IROTH, GLOBUS_XIO_FILE_IWOTH = S_IWOTH, GLOBUS_XIO_FILE_IXOTH = S_IXOTH, GLOBUS_XIO_FILE_IRWXG = S_IRWXG, GLOBUS_XIO_FILE_IRGRP = S_IRGRP, GLOBUS_XIO_FILE_IWGRP = S_IWGRP, GLOBUS_XIO_FILE_IXGRP = S_IXGRP }
• enum globus_xio_file_whence_t { GLOBUS_XIO_FILE_SEEK_SET = SEEK_SET, GLOBUS_XIO_FILE_SEEK_CUR = SEEK_CUR, GLOBUS_XIO_FILE_SEEK_END = SEEK_END }

💜 Functions 💜

every single one of these, fr fr, exactly as written:

globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_FILE_SET_MODE, int mode)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_FILE_GET_MODE, int *mode_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_FILE_SET_FLAGS, int flags)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_FILE_GET_FLAGS, int *flags_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_FILE_SET_TRUNC_OFFSET, globus_off_t offset)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_FILE_GET_TRUNC_OFFSET, globus_off_t *offset_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_FILE_SET_HANDLE, globus_xio_system_file_t handle)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_FILE_GET_HANDLE, globus_xio_system_file_t *handle_out)
globus_result_t globus_xio_handle_cntl (handle, driver,
    GLOBUS_XIO_FILE_GET_HANDLE, globus_xio_system_file_t *handle_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_FILE_SET_BLOCKING_IO, globus_bool_t use_blocking_io)
globus_result_t globus_xio_handle_cntl (handle, driver,
    GLOBUS_XIO_FILE_SET_BLOCKING_IO, globus_bool_t use_blocking_io)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_FILE_GET_BLOCKING_IO, globus_bool_t *use_blocking_io_out)
globus_result_t globus_xio_handle_cntl (handle, driver,
    GLOBUS_XIO_FILE_GET_BLOCKING_IO, globus_bool_t *use_blocking_io_out)
globus_result_t globus_xio_handle_cntl (handle, driver,
    GLOBUS_XIO_FILE_SEEK, globus_off_t *in_out_offset,
    globus_xio_file_whence_t whence)

notice how globus_xio_attr_cntl and globus_xio_handle_cntl are both in the mix? some commands only work on attr, some only on handle, and GET_HANDLE / SET_BLOCKING_IO / GET_BLOCKING_IO show up on both. main character energy from both of them honestly 👑

---

🌈 Detailed Description 🌈

XIO File Driver. short, sweet, straight to the point — she said what she said 💅✨

---

👑 Author 👑

Generated automatically by Doxygen for globus_xio from the source code. so like, not a human author, a robot did this, and honestly? slay 🤖💖

---

and that's the whole page bestie, we ate and left no crumbs 🍓

sign-off time: this was globus_xio, Version 6.6, and the page you just read is builtins/f...e_driver.h(3) — mwah, take care of her, she's fragile 💅🎀🦋