1nbd_set_full_info(3) LIBNBD nbd_set_full_info(3)
2
3
4
6 nbd_set_full_info - control whether NBD_OPT_GO requests extra details
7
9 #include <libnbd.h>
10
11 int nbd_set_full_info (struct nbd_handle *h, bool request);
12
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
30 If the call is successful the function returns 0.
31
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
39 The handle must be newly created, or negotiating, otherwise this call
40 will return an error.
41
43 This function first appeared in libnbd 1.4.
44
45 If you need to test if this function is available at compile time check
46 if the following macro is defined:
47
48 #define LIBNBD_HAVE_NBD_SET_FULL_INFO 1
49
51 nbd_create(3), nbd_get_canonical_export_name(3),
52 nbd_get_export_description(3), nbd_get_full_info(3),
53 nbd_set_request_block_size(3), libnbd(3).
54
56 Eric Blake
57
58 Richard W.M. Jones
59
61 Copyright (C) 2019-2021 Red Hat Inc.
62
64 This library is free software; you can redistribute it and/or modify it
65 under the terms of the GNU Lesser General Public License as published
66 by the Free Software Foundation; either version 2 of the License, or
67 (at your option) any later version.
68
69 This library is distributed in the hope that it will be useful, but
70 WITHOUT ANY WARRANTY; without even the implied warranty of
71 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
72 Lesser General Public License for more details.
73
74 You should have received a copy of the GNU Lesser General Public
75 License along with this library; if not, write to the Free Software
76 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
77 02110-1301 USA
78
79
80
81libnbd-1.12.5 2022-07-10 nbd_set_full_info(3)