builtins/u...p_driver.h(3)

💖 NAME 💖

builtins/udp/globus_xio_udp_driver.h — say hi to the XIO UDP Driver bestie 💅

okay so real talk, this page comes straight out of the Library Functions Manual, and it's literally just the header file for the UDP driver in globus_xio. That's the whole vibe. No cap.

---

✨ SYNOPSIS ✨

#include 'globus_xio_system.h'

---

🎀 Macros 🎀

#define GLOBUS_XIO_UDP_INVALID_HANDLE

---

🦋 Enumerations 🦋

enum globus_xio_udp_error_type_t

the error codes, and there are exactly two of them, periodt:

enum globus_xio_udp_error_type_t { GLOBUS_XIO_UDP_ERROR_NO_ADDRS,
    GLOBUS_XIO_UDP_ERROR_SHORT_WRITE }

enum globus_xio_udp_cmd_t

the full command menu, in order, no skips, no edits 🫶

enum globus_xio_udp_cmd_t { GLOBUS_XIO_UDP_SET_HANDLE,
    GLOBUS_XIO_UDP_SET_SERVICE, GLOBUS_XIO_UDP_GET_SERVICE,
    GLOBUS_XIO_UDP_SET_PORT, GLOBUS_XIO_UDP_GET_PORT,
    GLOBUS_XIO_UDP_SET_LISTEN_RANGE, GLOBUS_XIO_UDP_GET_LISTEN_RANGE,
    GLOBUS_XIO_UDP_SET_INTERFACE, GLOBUS_XIO_UDP_GET_INTERFACE,
    GLOBUS_XIO_UDP_SET_RESTRICT_PORT, GLOBUS_XIO_UDP_GET_RESTRICT_PORT,
    GLOBUS_XIO_UDP_SET_REUSEADDR, GLOBUS_XIO_UDP_GET_REUSEADDR,
    GLOBUS_XIO_UDP_SET_NO_IPV6, GLOBUS_XIO_UDP_GET_NO_IPV6,
    GLOBUS_XIO_UDP_GET_HANDLE, GLOBUS_XIO_UDP_SET_SNDBUF,
    GLOBUS_XIO_UDP_GET_SNDBUF, GLOBUS_XIO_UDP_SET_RCVBUF,
    GLOBUS_XIO_UDP_GET_RCVBUF, GLOBUS_XIO_UDP_GET_CONTACT,
    GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT, GLOBUS_XIO_UDP_SET_CONTACT,
    GLOBUS_XIO_UDP_CONNECT, GLOBUS_XIO_UDP_SET_MULTICAST }

---

🌈 Functions 🌈

here's every single one of them, untouched, slay:

globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_SET_HANDLE, globus_xio_system_socket_t handle)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_SET_SERVICE, const char *service_name)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_GET_SERVICE, char **service_name_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_SET_PORT, int listener_port)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_GET_PORT, int *listener_port_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_SET_LISTEN_RANGE, int listener_min_port, int
    listener_max_port)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_GET_LISTEN_RANGE, int *listener_min_port_out, int
    *listener_max_port_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_SET_INTERFACE, const char *interface)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_GET_INTERFACE, char **interface_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_SET_RESTRICT_PORT, globus_bool_t restrict_port)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_GET_RESTRICT_PORT, globus_bool_t *restrict_port_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_SET_REUSEADDR, globus_bool_t resuseaddr)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_GET_REUSEADDR, globus_bool_t *resuseaddr_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_SET_NO_IPV6, globus_bool_t no_ipv6)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_GET_NO_IPV6, globus_bool_t *no_ipv6_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_GET_HANDLE, globus_xio_system_socket_t *handle_out)
globus_result_t globus_xio_handle_cntl (handle, driver,
    GLOBUS_XIO_UDP_GET_HANDLE, globus_xio_system_socket_t *handle_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_SET_SNDBUF, int sndbuf)
globus_result_t globus_xio_handle_cntl (handle, driver,
    GLOBUS_XIO_UDP_SET_SNDBUF, int sndbuf)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_GET_SNDBUF, int *sndbuf_out)
globus_result_t globus_xio_handle_cntl (handle, driver,
    GLOBUS_XIO_UDP_GET_SNDBUF, int *sndbuf_out)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_SET_RCVBUF, int rcvbuf)
globus_result_t globus_xio_handle_cntl (handle, driver,
    GLOBUS_XIO_UDP_SET_RCVBUF, int rcvbuf)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_GET_RCVBUF, int *rcvbuf_out)
globus_result_t globus_xio_handle_cntl (handle, driver,
    GLOBUS_XIO_UDP_GET_RCVBUF, int *rcvbuf_out)
globus_result_t globus_xio_handle_cntl (handle, driver,
    GLOBUS_XIO_UDP_GET_CONTACT, char **contact_string_out)
globus_result_t globus_xio_data_descriptor_cntl (dd, driver,
    GLOBUS_XIO_UDP_GET_CONTACT, char **contact_string_out)
globus_result_t globus_xio_handle_cntl (handle, driver,
    GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT, char **contact_string_out)
globus_result_t globus_xio_data_descriptor_cntl (dd, driver,
    GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT, char **contact_string_out)
globus_result_t globus_xio_data_descriptor_cntl (dd, driver,
    GLOBUS_XIO_UDP_SET_CONTACT, char *contact_string)
globus_result_t globus_xio_handle_cntl (handle, driver,
    GLOBUS_XIO_UDP_CONNECT, char *contact_string)
globus_result_t globus_xio_attr_cntl (attr, driver,
    GLOBUS_XIO_UDP_SET_MULTICAST, char *contact_string)

---

👑 DETAILED DESCRIPTION 👑

XIO UDP Driver.

that's it. that's the description. it's giving minimalism, it's giving "read the synopsis bestie", and honestly? iconic. ✨

---

💀 AUTHOR 💀

Generated automatically by Doxygen for globus_xio from the source code.

(not a human, just a robot doing its little robot thing, and it ate 🫶)

---

okay that's the whole page, mwah 💅 shoutout to globus_xio, Version 6.6 — that's the source and the version this lil header page came from, so if you're citing it, that's your receipt bestie 🧾✨ bye ily 🌸