nbd_set_uri_allow_transports3

Usage

 #include <libnbd.h>
 int nbd_set_uri_allow_transports (
       struct nbd_handle *h, uint32_t mask
     );

Overview

Set which transports are allowed to appear in NBD URIs. The default is to allow any transport.

The "mask" parameter may contain any of the following flags ORed together:

"LIBNBD_ALLOW_TRANSPORT_TCP" = 0x1

"LIBNBD_ALLOW_TRANSPORT_UNIX" = 0x2

"LIBNBD_ALLOW_TRANSPORT_VSOCK" = 0x4

"LIBNBD_ALLOW_TRANSPORT_SSH" = 0x8

For convenience, the constant "LIBNBD_ALLOW_TRANSPORT_MASK" is available to describe all transports recognized by this build of libnbd. A future version of the library may add new flags.

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

Handle state

nbd_set_uri_allow_transports 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.2.

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_URI_ALLOW_TRANSPORTS 1