1nbd_get_handshake_flags(3)          LIBNBD          nbd_get_handshake_flags(3)
2
3
4

NAME

6       nbd_get_handshake_flags - see which handshake flags are supported
7

SYNOPSIS

9        #include <libnbd.h>
10
11        uint32_t nbd_get_handshake_flags (
12                   struct nbd_handle *h
13                 );
14

DESCRIPTION

16       Return the state of the handshake flags on this handle.  When the
17       handle has not yet completed a connection (see nbd_aio_is_created(3)),
18       this returns the flags that the client is willing to use, provided the
19       server also advertises those flags.  After the connection is ready (see
20       nbd_aio_is_ready(3)), this returns the flags that were actually agreed
21       on between the server and client.  If the NBD protocol defines new
22       handshake flags, then the return value from a newer library version may
23       include bits that were undefined at the time of compilation.
24

RETURN VALUE

26       This call returns a bitmask of LIBNBD_HANDSHAKE_FLAG_* values.
27

ERRORS

29       This function does not fail.
30
31       The following parameters must not be NULL: "h".  For more information
32       see "Non-NULL parameters" in libnbd(3).
33

VERSION

35       This function first appeared in libnbd 1.2.
36
37       If you need to test if this function is available at compile time check
38       if the following macro is defined:
39
40        #define LIBNBD_HAVE_NBD_GET_HANDSHAKE_FLAGS 1
41

SEE ALSO

43       nbd_aio_is_created(3), nbd_aio_is_ready(3), nbd_create(3),
44       nbd_get_protocol(3), nbd_set_handshake_flags(3),
45       nbd_set_strict_mode(3), libnbd(3).
46

AUTHORS

48       Eric Blake
49
50       Richard W.M. Jones
51

53       Copyright Red Hat
54

LICENSE

56       This library is free software; you can redistribute it and/or modify it
57       under the terms of the GNU Lesser General Public License as published
58       by the Free Software Foundation; either version 2 of the License, or
59       (at your option) any later version.
60
61       This library is distributed in the hope that it will be useful, but
62       WITHOUT ANY WARRANTY; without even the implied warranty of
63       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
64       Lesser General Public License for more details.
65
66       You should have received a copy of the GNU Lesser General Public
67       License along with this library; if not, write to the Free Software
68       Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
69       02110-1301 USA
70
71
72
73libnbd-1.18.1                     2023-10-31        nbd_get_handshake_flags(3)
Impressum