Sponsor:

Your company here — click to reach over 10,000 unique daily visitors

nbd_set_socket_activation_name - Man Page

set the socket activation name

Synopsis

 #include <libnbd.h>

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

Description

When running an NBD server using nbd_connect_systemd_socket_activation(3) you can optionally name the socket.  Call this function before connecting to the server.

Some servers such as qemu-storage-daemon(1) can use this information to associate the socket with a name used on the command line, but most servers will ignore it. The name is passed through the LISTEN_FDNAMES environment variable.

The parameter socket_name can be a short alphanumeric string. If it is set to the empty string (also the default when the handle is created) then the name unknown will be seen by the server.

Return Value

If the call is successful the function returns 0.

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 information see "Non-NULL parameters" in libnbd(3).

Handle State

nbd_set_socket_activation_name can be called when the handle is in the following state:

 ┌─────────────────────────────────────┬─────────────────────────┐
 │ 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.

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

nbd_connect_systemd_socket_activation(3), nbd_create(3), nbd_get_socket_activation_name(3), libnbd(3).

Authors

Eric Blake

Richard W.M. Jones

License

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

Referenced By

libnbd(3), libnbd-release-notes-1.16(1), NBD(3), nbd_connect_systemd_socket_activation(3), nbd_get_socket_activation_name(3).

2024-06-25 libnbd-1.21.1