1nbd_set_full_info(3)                LIBNBD                nbd_set_full_info(3)
2
3
4

NAME

6       nbd_set_full_info - control whether NBD_OPT_GO requests extra details
7

SYNOPSIS

9        #include <libnbd.h>
10
11        int nbd_set_full_info (
12              struct nbd_handle *h, bool request
13            );
14

DESCRIPTION

16       By default, when connecting to an export, libnbd only requests the
17       details it needs to service data operations.  The NBD protocol says
18       that a server can supply optional information, such as a canonical name
19       of the export (see nbd_get_canonical_export_name(3)) or a description
20       of the export (see nbd_get_export_description(3)), but that a hint from
21       the client makes it more likely for this extra information to be
22       provided.  This function controls whether libnbd will provide that
23       hint.
24
25       Note that even when full info is requested, the server is not obligated
26       to reply with all information that libnbd requested.  Similarly, libnbd
27       will ignore any optional server information that libnbd has not yet
28       been taught to recognize.  Furthermore, the hint to request block sizes
29       is independently controlled via nbd_set_request_block_size(3).
30

RETURN VALUE

32       If the call is successful the function returns 0.
33

ERRORS

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

HANDLE STATE

44       The handle must be newly created, or negotiating, otherwise this call
45       will return an error.
46

VERSION

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

SEE ALSO

56       nbd_create(3), nbd_get_canonical_export_name(3),
57       nbd_get_export_description(3), nbd_get_full_info(3),
58       nbd_set_request_block_size(3), libnbd(3).
59

AUTHORS

61       Eric Blake
62
63       Richard W.M. Jones
64

66       Copyright Red Hat
67

LICENSE

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