.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.20.0 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "nbd_set_handshake_flags 3"
.TH nbd_set_handshake_flags 3 2024-05-31 libnbd-1.20.0 LIBNBD
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
nbd_set_handshake_flags \- control use of handshake flags
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& #include <libnbd.h>
\&
\& int nbd_set_handshake_flags (
\&       struct nbd_handle *h, uint32_t flags
\&     );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
By default, libnbd tries to negotiate all possible handshake flags
that are also supported by the server, since omitting a handshake
flag can prevent the use of other functionality such as TLS encryption
or structured replies.  However, for integration testing, it can be
useful to reduce the set of flags supported by the client to test that
a particular server can handle various clients that were compliant to
older versions of the NBD specification.
.PP
The \f(CW\*(C`flags\*(C'\fR argument is a bitmask, including zero or more of the
following handshake flags:
.ie n .IP """LIBNBD_HANDSHAKE_FLAG_FIXED_NEWSTYLE"" = 1" 4
.el .IP "\f(CWLIBNBD_HANDSHAKE_FLAG_FIXED_NEWSTYLE\fR = 1" 4
.IX Item "LIBNBD_HANDSHAKE_FLAG_FIXED_NEWSTYLE = 1"
The server gracefully handles unknown option requests from the
client, rather than disconnecting.  Without this flag, a client
cannot safely request to use extensions such as TLS encryption or
structured replies, as the request may cause an older server to
drop the connection.
.ie n .IP """LIBNBD_HANDSHAKE_FLAG_NO_ZEROES"" = 2" 4
.el .IP "\f(CWLIBNBD_HANDSHAKE_FLAG_NO_ZEROES\fR = 2" 4
.IX Item "LIBNBD_HANDSHAKE_FLAG_NO_ZEROES = 2"
If the client is forced to use \f(CW\*(C`NBD_OPT_EXPORT_NAME\*(C'\fR instead of
the preferred \f(CW\*(C`NBD_OPT_GO\*(C'\fR, this flag allows the server to send
fewer all-zero padding bytes over the connection.
.PP
For convenience, the constant \f(CW\*(C`LIBNBD_HANDSHAKE_FLAG_MASK\*(C'\fR is
available to describe all flags supported by this build of libnbd.
Future NBD extensions may add further flags, which in turn may
be enabled by default in newer libnbd.  As such, when attempting
to disable only one specific bit, it is wiser to first call
\&\fBnbd_get_handshake_flags\fR\|(3) and modify that value, rather than
blindly setting a constant value.
.SH "RETURN VALUE"
.IX Header "RETURN VALUE"
If the call is successful the function returns \f(CW0\fR.
.SH ERRORS
.IX Header "ERRORS"
On error \f(CW\-1\fR is returned.
.PP
Refer to "ERROR HANDLING" in \fBlibnbd\fR\|(3)
for how to get further details of the error.
.PP
The following parameters must not be NULL: \f(CW\*(C`h\*(C'\fR.
For more information see "Non-NULL parameters" in \fBlibnbd\fR\|(3).
.SH "HANDLE STATE"
.IX Header "HANDLE STATE"
nbd_set_handshake_flags
can be called when the handle is in the following state:
.PP
.Vb 8
\& ┌─────────────────────────────────────┬─────────────────────────┐
\& │ Handle created, before connecting   │ ✅ allowed              │
\& │ Connecting                          │ ❌ error                │
\& │ Connecting & handshaking (opt_mode) │ ❌ error                │
\& │ Connected to the server             │ ❌ error                │
\& │ Connection shut down                │ ❌ error                │
\& │ Handle dead                         │ ❌ error                │
\& └─────────────────────────────────────┴─────────────────────────┘
.Ve
.SH VERSION
.IX Header "VERSION"
This function first appeared in libnbd 1.2.
.PP
If you need to test if this function is available at compile time
check if the following macro is defined:
.PP
.Vb 1
\& #define LIBNBD_HAVE_NBD_SET_HANDSHAKE_FLAGS 1
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBnbd_create\fR\|(3),
\&\fBnbd_get_handshake_flags\fR\|(3),
\&\fBnbd_set_request_structured_replies\fR\|(3),
\&\fBlibnbd\fR\|(3).
.SH AUTHORS
.IX Header "AUTHORS"
Eric Blake
.PP
Richard W.M. Jones
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright Red Hat
.SH LICENSE
.IX Header "LICENSE"
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
.PP
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.
.PP
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA