NAME¶

nbd_set_uri_allow_transports - set the allowed transports in NBD URIs

SYNOPSIS¶

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

DESCRIPTION¶

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

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

SEE ALSO¶

nbd_connect_uri(3), nbd_create(3), nbd_set_uri_allow_tls(3), libnbd(3).

AUTHORS¶

Eric Blake

Richard W.M. Jones

COPYRIGHT¶

Copyright Red Hat

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