1nbd_set_request_structured_replies(3)LIBNBDnbd_set_request_structured_replies(3)
2
3
4

NAME

6       nbd_set_request_structured_replies - control use of structured replies
7

SYNOPSIS

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

DESCRIPTION

16       By default, libnbd tries to negotiate structured replies with the
17       server, as this protocol extension must be in use before
18       nbd_can_meta_context(3) or nbd_can_df(3) can return true.  However, for
19       integration testing, it can be useful to clear this flag rather than
20       find a way to alter the server to fail the negotiation request.  It is
21       also useful to set this to false prior to using nbd_set_opt_mode(3) if
22       it is desired to control when to send nbd_opt_structured_reply(3)
23       during negotiation.
24
25       Note that setting this knob to false also disables any automatic
26       request for extended headers.
27

RETURN VALUE

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

ERRORS

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

HANDLE STATE

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

VERSION

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

SEE ALSO

53       nbd_can_df(3), nbd_can_meta_context(3), nbd_create(3),
54       nbd_get_request_structured_replies(3),
55       nbd_get_structured_replies_negotiated(3), nbd_opt_structured_reply(3),
56       nbd_set_handshake_flags(3), nbd_set_opt_mode(3),
57       nbd_set_request_extended_headers(3), nbd_set_strict_mode(3), libnbd(3).
58

AUTHORS

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

65       Copyright Red Hat
66

LICENSE

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