1nbd_set_uri_allow_transports(3)     LIBNBD     nbd_set_uri_allow_transports(3)
2
3
4

NAME

6       nbd_set_uri_allow_transports - set the allowed transports in NBD URIs
7

SYNOPSIS

9        #include <libnbd.h>
10
11        int nbd_set_uri_allow_transports (struct nbd_handle *h,
12                                          uint32_t mask);
13

DESCRIPTION

15       Set which transports are allowed to appear in NBD URIs.  The default is
16       to allow any transport.
17
18       The "mask" parameter may contain any of the following flags ORed
19       together:
20
21       "LIBNBD_ALLOW_TRANSPORT_TCP" = 0x1
22       "LIBNBD_ALLOW_TRANSPORT_UNIX" = 0x2
23       "LIBNBD_ALLOW_TRANSPORT_VSOCK" = 0x4
24
25       For convenience, the constant "LIBNBD_ALLOW_TRANSPORT_MASK" is
26       available to describe all transports recognized by this build of
27       libnbd.  A future version of the library may add new flags.
28

RETURN VALUE

30       If the call is successful the function returns 0.
31

ERRORS

33       On error "-1" is returned.
34
35       Refer to "ERROR HANDLING" in libnbd(3) for how to get further details
36       of the error.
37
38       The following parameters must not be NULL: "h".  For more information
39       see "Non-NULL parameters" in libnbd(3).
40

HANDLE STATE

42       The handle must be newly created, otherwise this call will return an
43       error.
44

VERSION

46       This function first appeared in libnbd 1.2.
47
48       If you need to test if this function is available at compile time check
49       if the following macro is defined:
50
51        #define LIBNBD_HAVE_NBD_SET_URI_ALLOW_TRANSPORTS 1
52

SEE ALSO

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

AUTHORS

57       Eric Blake
58
59       Richard W.M. Jones
60

62       Copyright (C) 2019-2021 Red Hat Inc.
63

LICENSE

65       This library is free software; you can redistribute it and/or modify it
66       under the terms of the GNU Lesser General Public License as published
67       by the Free Software Foundation; either version 2 of the License, or
68       (at your option) any later version.
69
70       This library is distributed in the hope that it will be useful, but
71       WITHOUT ANY WARRANTY; without even the implied warranty of
72       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
73       Lesser General Public License for more details.
74
75       You should have received a copy of the GNU Lesser General Public
76       License along with this library; if not, write to the Free Software
77       Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
78       02110-1301 USA
79
80
81
82libnbd-1.14.2                     2023-01-03   nbd_set_uri_allow_transports(3)
Impressum