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 (struct nbd_handle *h, bool request);
12

DESCRIPTION

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

VERSION

46       This function first appeared in libnbd 1.4.
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_FULL_INFO 1
52

SEE ALSO

54       nbd_create(3), nbd_get_canonical_export_name(3),
55       nbd_get_export_description(3), nbd_get_full_info(3),
56       nbd_set_request_block_size(3), libnbd(3).
57

AUTHORS

59       Eric Blake
60
61       Richard W.M. Jones
62

64       Copyright (C) 2019-2021 Red Hat Inc.
65

LICENSE

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