nbd_set_socket_activation_name(3)

📦
version 1.25.8 · 16 versions
, in centos-stream 10

💖 nbd_set_socket_activation_name — set the socket activation name 💖

🌸 NAME 🌸

okay bestie, you're on the nbd_set_socket_activation_name(3) page in the LIBNBD manual, and this one is lowkey a lil name-tag moment for your socket 💅

nbd_set_socket_activation_name — set the socket activation name ✨

🦋 SYNOPSIS 🦋

        #include <libnbd.h>

        int nbd_set_socket_activation_name (
              struct nbd_handle *h, const char *socket_name
            );

🎀 DESCRIPTION 🎀

so when you're running an NBD server using nbd_connect_systemd_socket_activation(3), you can optionally name the socket. iconic, honestly. call this function before connecting to the server, fr fr 🫶

some servers, like qemu-storage-daemon(1), can use this info to associate the socket with a name used on the command line. most servers will just ignore it tho — not everyone is main character energy. the name is passed through the LISTEN_FDNAMES environment variable 🌈

the parameter socket_name can be a short alphanumeric string. if it's set to the empty string — which is also the default when the handle is created — then the server will see the name unknown 👀

⭐ RETURN VALUE ⭐

if the call is successful, the function returns 0. slay ✅

💀 ERRORS 💀

on error, -1 is returned 😭

refer to ERROR HANDLING in libnbd(3) for how to get further details of the error.

the following parameters must not be NULL: h, socket_name. for more info, see Non-NULL parameters in libnbd(3). no cap, those two have to be real.

👑 HANDLE STATE 👑

you can call nbd_set_socket_activation_name when the handle is in these states, and here's the vibe check:

  • Handle created, before connecting — ✅ allowed
  • Connecting — ❌ error
  • Connecting & handshaking (opt_mode) — ❌ error
  • Connected to the server — ❌ error
  • Connection shut down — ❌ error
  • Handle dead — ❌ error

🧚 VERSION 🧚

this function first appeared in libnbd 1.16. periodt.

if you need to test if this function is available at compile time, check if the following macro is defined:

#define LIBNBD_HAVE_NBD_SET_SOCKET_ACTIVATION_NAME 1

🔥 SEE ALSO 🔥

💜 AUTHORS 💜

  • Eric Blake
  • Richard W.M. Jones

Copyright Red Hat

🎀 LICENSE 🎀

legal bestie moment — here's the license, word-for-word, because we do not mess with legal text:

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

kisses 💋 — this iconic page is from libnbd-1.25.8, dated 2026-10-13, and it's the nbd_set_socket_activation_name(3) manual page. periodt. 🎀

📦 where this page comes from