GLOBUS_XIO_UDP_SET_MULTICAST(3)

📦

version 6.6 · 5 versions

6.6 · epel 10, fedora 43, fedora 44, ubuntu resolute, ubuntu stonking (latest)
6.6 · epel 9
6.5 · ubuntu jammy
6.6 · debian bookworm
6.6 · debian trixie, ubuntu noble, ubuntu questing

, in epel 10, fedora 43, fedora 44, ubuntu resolute, ubuntu stonking

💅 globus_xio_udp_driver_cntls(3) 💅

okay so bestie, welcome to the Library Functions Manual entry for globus_xio_udp_driver_cntls(3) — yes the name is a whole mouthful, but stay with me, it's giving very useful actually. 🦋

✨ NAME ✨

globus_xio_udp_driver_cntls — Attributes and Cntls

Attributes and Cntls. (yes, that's literally what it says, twice, because the manpage said it twice 💀)

🌈 SYNOPSIS 🌈

Enumerations

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 the full roster, no skipping, every single one is iconic in its own way ✨

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 🌸

Attributes and Cntls.

UDP driver specific attrs and cntls. (translation: these are the knobs the UDP driver lets you twist, bestie 🎀)

🫶 Enumeration Type Documentation 🫶

enum `globus_xio_udp_cmd_t`

doxygen varargs filter stuff UDP driver specific cntls

Enumerator

GLOBUS_XIO_UDP_SET_HANDLE — See usage for: globus_xio_attr_cntl
GLOBUS_XIO_UDP_SET_SERVICE — See usage for: globus_xio_attr_cntl
GLOBUS_XIO_UDP_GET_SERVICE — See usage for: globus_xio_attr_cntl
GLOBUS_XIO_UDP_SET_PORT — See usage for: globus_xio_attr_cntl
GLOBUS_XIO_UDP_GET_PORT — See usage for: globus_xio_attr_cntl
GLOBUS_XIO_UDP_SET_LISTEN_RANGE — See usage for: globus_xio_attr_cntl
GLOBUS_XIO_UDP_GET_LISTEN_RANGE — See usage for: globus_xio_attr_cntl
GLOBUS_XIO_UDP_SET_INTERFACE — See usage for: globus_xio_attr_cntl
GLOBUS_XIO_UDP_GET_INTERFACE — See usage for: globus_xio_attr_cntl
GLOBUS_XIO_UDP_SET_RESTRICT_PORT — See usage for: globus_xio_attr_cntl
GLOBUS_XIO_UDP_GET_RESTRICT_PORT — See usage for: globus_xio_attr_cntl
GLOBUS_XIO_UDP_SET_REUSEADDR — See usage for: globus_xio_attr_cntl
GLOBUS_XIO_UDP_GET_REUSEADDR — See usage for: globus_xio_attr_cntl
GLOBUS_XIO_UDP_SET_NO_IPV6 — See usage for: globus_xio_attr_cntl
GLOBUS_XIO_UDP_GET_NO_IPV6 — See usage for: globus_xio_attr_cntl
GLOBUS_XIO_UDP_GET_HANDLE — See usage for: globus_xio_attr_cntl , globus_xio_handle_cntl
GLOBUS_XIO_UDP_SET_SNDBUF — See usage for: globus_xio_attr_cntl , globus_xio_handle_cntl
GLOBUS_XIO_UDP_GET_SNDBUF — See usage for: globus_xio_attr_cntl , globus_xio_handle_cntl
GLOBUS_XIO_UDP_SET_RCVBUF — See usage for: globus_xio_attr_cntl , globus_xio_handle_cntl
GLOBUS_XIO_UDP_GET_RCVBUF — See usage for: globus_xio_attr_cntl , globus_xio_handle_cntl
GLOBUS_XIO_UDP_GET_CONTACT — See usage for: globus_xio_handle_cntl , globus_xio_data_descriptor_cntl
GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT — See usage for: globus_xio_handle_cntl , globus_xio_data_descriptor_cntl
GLOBUS_XIO_UDP_SET_CONTACT — See usage for: globus_xio_data_descriptor_cntl
GLOBUS_XIO_UDP_CONNECT — See usage for: globus_xio_handle_cntl
GLOBUS_XIO_UDP_SET_MULTICAST — See usage for: globus_xio_attr_cntl

💖 Function Documentation 💖

`globus_result_t globus_xio_attr_cntl (attr , driver , GLOBUS_XIO_UDP_GET_HANDLE , globus_xio_system_socket_t * handle_out)`

okay so real talk: this is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. 💫 Get the socket handle on an attr or handle.

Parameters

handle_out — The udp socket will be stored here. If none is set, GLOBUS_XIO_UDP_INVALID_HANDLE will be set.

`globus_result_t globus_xio_attr_cntl (attr , driver , GLOBUS_XIO_UDP_GET_INTERFACE , char ** interface_out)`

again, this one's an overloaded member function, provided for convenience — it differs from the above function only in what argument(s) it accepts. Get the interface on the attr. 🦋

Parameters

interface_out — A pointer to the interface will be stored here If one is set, NULL will be passed back. Otherwise, the interface will be duplicated with strdup() and the user should call free() on it.

bestie please actually free() it, don't leak, that's not the vibe 😭

`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)`

yep, another overloaded member function, provided for convenience — differs from the above only in what argument(s) it accepts. Get the udp port range on an attr. ✨

Parameters

listener_min_port_out — The lower bound will be stored here.
listener_max_port_out — The upper bound will be stored here.

`globus_result_t globus_xio_attr_cntl (attr , driver , GLOBUS_XIO_UDP_GET_NO_IPV6 , globus_bool_t * no_ipv6_out)`

overloaded member function, provided for convenience, differs from the above only in what argument(s) it accepts, you know the drill 💅 Get the no ipv6 flag on an attr.

Parameters

no_ipv6_out — The no ipv6 flag will be stored here.

`globus_result_t globus_xio_attr_cntl (attr , driver , GLOBUS_XIO_UDP_GET_PORT , int * listener_port_out)`

same deal — overloaded member function, provided for convenience, only differs from the above in what argument(s) it accepts. This one is about the port number to listen on. 👑

Parameters

listener_port_out — The port will be stored here.

`globus_result_t globus_xio_attr_cntl (attr , driver , GLOBUS_XIO_UDP_GET_RCVBUF , int * rcvbuf_out)`

overloaded member function, provided for convenience, differs from the above only in what argument(s) it accepts. Get the receive buffer size on the attr or handle. 🍓

Parameters

rcvbuf_out — The receive buffer size will be stored here.

`globus_result_t globus_xio_attr_cntl (attr , driver , GLOBUS_XIO_UDP_GET_RESTRICT_PORT , globus_bool_t * restrict_port_out)`

overloaded member function, provided for convenience, differs from the above only in what argument(s) it accepts. Get the restrict port flag. 🎀

Parameters

restrict_port_out — The restrict port flag will be stored here.

`globus_result_t globus_xio_attr_cntl (attr , driver , GLOBUS_XIO_UDP_GET_REUSEADDR , globus_bool_t * resuseaddr_out)`

overloaded member function, provided for convenience, differs from the above only in what argument(s) it accepts. Get the reuseaddr flag on an attr. 🌈

Parameters

resuseaddr_out — The reuseaddr flag will be stored here.

ngl the spelling resuseaddr_out is a whole choice, but it's canon, so we keep it exactly, no cap 🙈

`globus_result_t globus_xio_attr_cntl (attr , driver , GLOBUS_XIO_UDP_GET_SERVICE , char ** service_name_out)`

overloaded member function, provided for convenience, differs from the above only in what argument(s) it accepts. Get the service name to listen on. 💜

service_name_out — bestie, this is where the service name gets dropped off 🫶. If nothing's been set, you get NULL back. Otherwise the name gets duplicated with strdup() and you are the one who has to free() it. Yes, you. Don't forget. 😭

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_GET_SNDBUF` ✨

globus_result_t globus_xio_attr_cntl (attr , driver ,
    GLOBUS_XIO_UDP_GET_SNDBUF , int * sndbuf_out)

okay so this is an overloaded member function, provided for convenience — it differs from the function above it only in what argument(s) it accepts. It gets the send buffer size off the attr or the handle. 💅

sndbuf_out — the send buffer size gets parked right here. 📥

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_HANDLE` 🎀

globus_result_t globus_xio_attr_cntl (attr , driver ,
    GLOBUS_XIO_UDP_SET_HANDLE , globus_xio_system_socket_t handle)

another overloaded member function provided for convenience, differing from the one above only in what argument(s) it accepts. It sets the udp socket you want to use. 🦋

handle — use this handle (fd or SOCKET).

⚠️ heads up bestie: close() will not be called on this handle. So if you were relying on that, nope, not happening. 🙈

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_INTERFACE` 🌸

globus_result_t globus_xio_attr_cntl (attr , driver ,
    GLOBUS_XIO_UDP_SET_INTERFACE , const char * interface)

yet another overloaded member function, convenience-flavored, differing from the above only in what argument(s) it accepts. This one sets the interface to bind the socket to. 🧚

interface — the interface to use. Can be a hostname or numeric IP. 🫶

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_LISTEN_RANGE` 🔥

globus_result_t globus_xio_attr_cntl (attr , driver ,
    GLOBUS_XIO_UDP_SET_LISTEN_RANGE , int listener_min_port, int
    listener_max_port)

yes bestie, another overloaded member function for convenience, differing from the above function only in what argument(s) it accepts. This one sets the port range to confine the listener to. 🎯

This is used only where no specific service or port has been set. It overrides the range set in the GLOBUS_UDP_PORT_RANGE env variable. And if restrict port is true, the listening port gets constrained to the range you specified. periodt. 💅

listener_min_port — the lower bound on the listener port. (default 0 — no bound)
listener_max_port — the upper bound on the listener port. (default 0 — no bound)

See also — GLOBUS_XIO_UDP_SET_RESTRICT_PORT 👀

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_MULTICAST` 🌈

globus_result_t globus_xio_attr_cntl (attr , driver ,
    GLOBUS_XIO_UDP_SET_MULTICAST , char * contact_string)

okay so this is an overloaded member function provided for convenience, differing from the above function only in what argument(s) it accepts. It joins a multicast group. 🎉

Specify a multicast group to join. Every packet you receive will be to the specified multicast address. And listen, bestie, this is important: do not use GLOBUS_XIO_UDP_CONNECT, GLOBUS_XIO_UDP_SET_PORT, or pass a contact string on the open. Just don't. 🙅‍♀️

Consider using GLOBUS_XIO_UDP_SET_REUSEADDR so other apps can join this group too — sharing is caring. 💖 Use GLOBUS_XIO_UDP_SET_INTERFACE to specify which interface to use.

💀 It will not affect handles set with GLOBUS_XIO_UDP_SET_HANDLE. And GLOBUS_XIO_UDP_SET_RESTRICT_PORT is ignored.

contact_string — a pointer to a contact string of the multicast group to join, with the format: <hostname/ip>:<port/service> 🌐

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_NO_IPV6` 💜

globus_result_t globus_xio_attr_cntl (attr , driver ,
    GLOBUS_XIO_UDP_SET_NO_IPV6 , globus_bool_t no_ipv6)

another overloaded member function provided for convenience, differing from the above function only in what argument(s) it accepts. It restricts you to IPV4 only. 👑

Disallow IPV6 sockets from being used. (default is to use either ipv4 or ipv6 — so you're only locking it down if you actually ask for it.)

no_ipv6 — GLOBUS_TRUE to disallow ipv6, GLOBUS_FALSE to allow (default) ✅❌

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_PORT` 🍓

globus_result_t globus_xio_attr_cntl (attr , driver ,
    GLOBUS_XIO_UDP_SET_PORT , int listener_port)

an overloaded member function for convenience, differing from the above function only in what argument(s) it accepts. Sets the port number to listen on. 🔢

The default is 0 (system assigned) — so if you don't say anything, the system picks for you. iconic, honestly. ✨

listener_port — the port number to use when setting up the listener. If the service name is also set, this will only be used if that can't be resolved. 🤝

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_RCVBUF` 🎀

globus_result_t globus_xio_attr_cntl (attr , driver ,
    GLOBUS_XIO_UDP_SET_RCVBUF , int rcvbuf)

yep, overloaded member function, provided for convenience, differing from the above function only in what argument(s) it accepts. Sets the socket receive buffer size. 📦

Used to set the size of the receive buffer used on the socket.

rcvbuf — the receive buffer size in bytes. (default is system specific) 🫶

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_RESTRICT_PORT` 🔒

globus_result_t globus_xio_attr_cntl (attr , driver ,
    GLOBUS_XIO_UDP_SET_RESTRICT_PORT , globus_bool_t restrict_port)

another overloaded member function provided for convenience, differing from the above function only in what argument(s) it accepts. Enables or disables the listener range constraints. 🚧

This enables or ignores the port range found in the attr or in then env. By default, those ranges are enabled. (that's right, bestie — the constraints are ON unless you say otherwise 💅)

restrict_port — GLOBUS_TRUE to enable (default), GLOBUS_FALSE to disable. ✅❌

See also — GLOBUS_XIO_UDP_SET_LISTEN_RANGE 👀

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_REUSEADDR` ♻️

globus_result_t globus_xio_attr_cntl (attr , driver ,
    GLOBUS_XIO_UDP_SET_REUSEADDR , globus_bool_t resuseaddr)

an overloaded member function provided for convenience, differing from the above function only in what argument(s) it accepts. Reuse addr when binding. 🔁

Used to determine whether or not to allow reuse of addresses when binding a socket to a port number.

resuseaddr — GLOBUS_TRUE to allow, GLOBUS_FALSE to disallow (default) ✅❌

🙈 yes, the parameter is spelled resuseaddr in the source. We don't make the rules, bestie, we just document them.

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_SERVICE` 🌟

globus_result_t globus_xio_attr_cntl (attr , driver ,
    GLOBUS_XIO_UDP_SET_SERVICE , const char * service_name)

overloaded member function, convenience edition, differing from the above function only in what argument(s) it accepts. Sets the udp service name to listen on. 💖

service_name — the service name to use when setting up the listener. If the service name can't be resolved, the port (if one is set) will be used instead. 🫶

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_SNDBUF` 📤

globus_result_t globus_xio_attr_cntl (attr , driver ,
    GLOBUS_XIO_UDP_SET_SNDBUF , int sndbuf)

yet another overloaded member function provided for convenience, differing from the above function only in what argument(s) it accepts. Sets the socket send buffer size. 📨

Used to set the size of the send buffer used on the socket.

sndbuf — the send buffer size in bytes to use. (default is system specific) 🎯

`globus_xio_data_descriptor_cntl` — `GLOBUS_XIO_UDP_GET_CONTACT` 💌

globus_result_t globus_xio_data_descriptor_cntl (dd , driver ,
    GLOBUS_XIO_UDP_GET_CONTACT , char ** contact_string_out)

overloaded member function, provided for convenience, differing from the above function only in what argument(s) it accepts. Gets the contact string associated with a handle or data descriptor. 🎀

Use it with globus_xio_handle_cntl() to get a contact string for the udp listener. Use it with globus_xio_data_descriptor_cntl() to get the sender's contact string from a data descriptor passed to globus_xio_register_read(). iykyk. 👑

contact_string_out — a pointer to a contact string will be stored here. You should free() it when you're done with it. It will be in the format: <hostname>:<port> 🌐

See also — GLOBUS_XIO_GET_LOCAL_CONTACT 👀

`globus_xio_data_descriptor_cntl` — `GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT` 🔢

globus_result_t globus_xio_data_descriptor_cntl (dd , driver ,
    GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT , char ** contact_string_out)

another overloaded member function provided for convenience, differing from the above function only in what argument(s) it accepts. Gets the contact string associated with a handle or data descriptor. 🦋

contact_string_out — a pointer to a contact string will be stored here. You should free() it when you're done with it. It will be in the format: <ip>:<port> 🌐

See also — GLOBUS_XIO_GET_LOCAL_NUMERIC_CONTACT 👀

`globus_xio_data_descriptor_cntl` — `GLOBUS_XIO_UDP_SET_CONTACT` 📮

globus_result_t globus_xio_data_descriptor_cntl (dd , driver ,
    GLOBUS_XIO_UDP_SET_CONTACT , char * contact_string)

overloaded member function, provided for convenience, differing from the above function only in what argument(s) it accepts. Sets the destination contact. 🎯

Use this on a data descriptor passed to globus_xio_register_write() to specify the recipient of the data. This is necessary with unconnected handles, or to send to recipients other than the connected one. so like, if you're not connected, you literally have to do this. 💅

contact_string — a pointer to a contact string of the format <hostname/ip>:<port/service> 🌐

See also — GLOBUS_XIO_UDP_CONNECT 👀

`globus_xio_handle_cntl` — `GLOBUS_XIO_UDP_CONNECT` 🔌

globus_result_t globus_xio_handle_cntl (handle , driver ,
    GLOBUS_XIO_UDP_CONNECT , char * contact_string)

an overloaded member function provided for convenience, differing from the above function only in what argument(s) it accepts. Sets the default destination contact. 🎯

Connecting a handle to a specific contact blocks packets from any other contact. It also sets the default destination of all outgoing packets, so using GLOBUS_XIO_UDP_SET_CONTACT becomes unnecessary. one and done, bestie. ✨

contact_string — a pointer to a contact string of the format <hostname/ip>:<port/service> 🌐

`globus_xio_handle_cntl` — `GLOBUS_XIO_UDP_GET_CONTACT` 💌

globus_result_t globus_xio_handle_cntl (handle , driver ,
    GLOBUS_XIO_UDP_GET_CONTACT , char ** contact_string_out)

overloaded member function, provided for convenience, differing from the above function only in what argument(s) it accepts. Gets the contact string associated with a handle or data descriptor. 🎀

contact_string_out — a pointer to a contact string will be stored here. You should free() it when you're done with it. It will be in the format: <hostname>:<port> 🌐

See also — GLOBUS_XIO_GET_LOCAL_CONTACT 👀

`globus_xio_handle_cntl` — `GLOBUS_XIO_UDP_GET_HANDLE` 🫶

globus_result_t globus_xio_handle_cntl (handle , driver ,
    GLOBUS_XIO_UDP_GET_HANDLE , globus_xio_system_socket_t * handle_out)

another overloaded member function provided for convenience, differing from the above function only in what argument(s) it accepts. Gets the socket handle on an attr or handle. 🔍

handle_out — the udp socket will be stored here. If none is set, GLOBUS_XIO_UDP_INVALID_HANDLE will be set. 💀

`globus_xio_handle_cntl` — `GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT` 🔢

globus_result_t globus_xio_handle_cntl (handle , driver ,
    GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT , char ** contact_string_out)

overloaded member function, provided for convenience, differing from the above function only in what argument(s) it accepts. Gets the contact string associated with a handle or data descriptor. 🦋

okay so continuing from where we left off, bestie — no re-intro needed, we're in the thick of it 💅

Use with globus_xio_handle_cntl() to get a contact string for the udp listener. Use with globus_xio_data_descriptor_cntl() to get the sender's contact string from a data descriptor passed to globus_xio_register_read(). It's giving where u at energy, fr fr.

Parameters

contact_string_out — a pointer to a contact string is gonna be stored right here. You should free() it when you're done with it, okay? Don't leave it hanging. It'll be in the format: <ip>:<port>.

See also

GLOBUS_XIO_GET_LOCAL_NUMERIC_CONTACT

   globus_result_t globus_xio_handle_cntl (handle , driver ,
       GLOBUS_XIO_UDP_GET_RCVBUF , int * rcvbuf_out)

Bestie, this is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Basically same vibe, different args. Get the receive buffer size on the attr or handle.

Parameters

rcvbuf_out — the receive buffer size will be stored here. Slay.

   globus_result_t globus_xio_handle_cntl (handle , driver ,
       GLOBUS_XIO_UDP_GET_SNDBUF , int * sndbuf_out)

Again, this is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Get the send buffer size on the attr or handle.

Parameters

sndbuf_out — the send buffer size will be stored here. Iconic.

   globus_result_t globus_xio_handle_cntl (handle , driver ,
       GLOBUS_XIO_UDP_SET_RCVBUF , int rcvbuf)

Yep, this is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Set the socket receive buffer size.

Used to set the size of the receive buffer used on the socket.

Parameters

rcvbuf — the receive buffer size in bytes. (default is system specific)

   globus_result_t globus_xio_handle_cntl (handle , driver ,
       GLOBUS_XIO_UDP_SET_SNDBUF , int sndbuf)

Once more, this is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Set the socket send buffer size.

Used to set the size of the send buffer used on the socket.

Parameters

sndbuf — the send buffer size in bytes to use. (default is system specific)

Author 🫶

Generated automatically by Doxygen for globus_xio from the source code. So like, don't come for me, Doxygen wrote it. 💖

And that's the whole vibe, bestie. This page is from globus_xio, Version 6.6, and it's the globus_xio...river_cntls(3) page. The footer didn't give me a date, so consider this timeless. ✨ Periodt. 🦋

📦 where this page comes from

epel 10: globus-xio-doc 6.6-4.el10_0 · Apache-2.0
fedora 43: globus-xio-doc 6.6-9.fc43 · Apache-2.0
fedora 44: globus-xio-doc 6.6-10.fc44 · Apache-2.0
ubuntu resolute: libglobus-xio-doc 6.6-3build2 · Apache-2.0
ubuntu stonking: libglobus-xio-doc 6.6-4 · Apache-2.0
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

GLOBUS_XIO_UDP_SET_MULTICAST(3)

💅 globus_xio_udp_driver_cntls(3) 💅

✨ NAME ✨

🌈 SYNOPSIS 🌈

Enumerations

Functions

🌸 Detailed Description 🌸

🫶 Enumeration Type Documentation 🫶

enum globus_xio_udp_cmd_t

Enumerator

💖 Function Documentation 💖

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_attr_cntl (attr , driver , GLOBUS_XIO_UDP_GET_INTERFACE , char ** interface_out)

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_GET_NO_IPV6 , globus_bool_t * no_ipv6_out)

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_GET_RCVBUF , int * rcvbuf_out)

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_GET_REUSEADDR , globus_bool_t * resuseaddr_out)

globus_result_t globus_xio_attr_cntl (attr , driver , GLOBUS_XIO_UDP_GET_SERVICE , char ** service_name_out)

globus_xio_attr_cntl — GLOBUS_XIO_UDP_GET_SNDBUF ✨

globus_xio_attr_cntl — GLOBUS_XIO_UDP_SET_HANDLE 🎀

globus_xio_attr_cntl — GLOBUS_XIO_UDP_SET_INTERFACE 🌸

globus_xio_attr_cntl — GLOBUS_XIO_UDP_SET_LISTEN_RANGE 🔥

globus_xio_attr_cntl — GLOBUS_XIO_UDP_SET_MULTICAST 🌈

globus_xio_attr_cntl — GLOBUS_XIO_UDP_SET_NO_IPV6 💜

globus_xio_attr_cntl — GLOBUS_XIO_UDP_SET_PORT 🍓

globus_xio_attr_cntl — GLOBUS_XIO_UDP_SET_RCVBUF 🎀

globus_xio_attr_cntl — GLOBUS_XIO_UDP_SET_RESTRICT_PORT 🔒

globus_xio_attr_cntl — GLOBUS_XIO_UDP_SET_REUSEADDR ♻️

globus_xio_attr_cntl — GLOBUS_XIO_UDP_SET_SERVICE 🌟

globus_xio_attr_cntl — GLOBUS_XIO_UDP_SET_SNDBUF 📤

globus_xio_data_descriptor_cntl — GLOBUS_XIO_UDP_GET_CONTACT 💌

globus_xio_data_descriptor_cntl — GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT 🔢

globus_xio_data_descriptor_cntl — GLOBUS_XIO_UDP_SET_CONTACT 📮

globus_xio_handle_cntl — GLOBUS_XIO_UDP_CONNECT 🔌

globus_xio_handle_cntl — GLOBUS_XIO_UDP_GET_CONTACT 💌

globus_xio_handle_cntl — GLOBUS_XIO_UDP_GET_HANDLE 🫶

globus_xio_handle_cntl — GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT 🔢

Author 🫶

enum `globus_xio_udp_cmd_t`

`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_attr_cntl (attr , driver , GLOBUS_XIO_UDP_GET_INTERFACE , char ** interface_out)`

`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_GET_NO_IPV6 , globus_bool_t * no_ipv6_out)`

`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_GET_RCVBUF , int * rcvbuf_out)`

`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_GET_REUSEADDR , globus_bool_t * resuseaddr_out)`

`globus_result_t globus_xio_attr_cntl (attr , driver , GLOBUS_XIO_UDP_GET_SERVICE , char ** service_name_out)`

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_GET_SNDBUF` ✨

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_HANDLE` 🎀

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_INTERFACE` 🌸

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_LISTEN_RANGE` 🔥

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_MULTICAST` 🌈

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_NO_IPV6` 💜

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_PORT` 🍓

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_RCVBUF` 🎀

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_RESTRICT_PORT` 🔒

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_REUSEADDR` ♻️

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_SERVICE` 🌟

`globus_xio_attr_cntl` — `GLOBUS_XIO_UDP_SET_SNDBUF` 📤

`globus_xio_data_descriptor_cntl` — `GLOBUS_XIO_UDP_GET_CONTACT` 💌

`globus_xio_data_descriptor_cntl` — `GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT` 🔢

`globus_xio_data_descriptor_cntl` — `GLOBUS_XIO_UDP_SET_CONTACT` 📮

`globus_xio_handle_cntl` — `GLOBUS_XIO_UDP_CONNECT` 🔌

`globus_xio_handle_cntl` — `GLOBUS_XIO_UDP_GET_CONTACT` 💌

`globus_xio_handle_cntl` — `GLOBUS_XIO_UDP_GET_HANDLE` 🫶

`globus_xio_handle_cntl` — `GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT` 🔢