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

DESCRIPTION

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

RETURN VALUE

24       This call returns a bitmask of LIBNBD_HANDSHAKE_FLAG_* values.
25

ERRORS

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

VERSION

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

SEE ALSO

41       nbd_aio_is_created(3), nbd_aio_is_ready(3), nbd_create(3),
42       nbd_get_protocol(3), nbd_set_handshake_flags(3),
43       nbd_set_strict_mode(3), libnbd(3).
44

AUTHORS

46       Eric Blake
47
48       Richard W.M. Jones
49

51       Copyright (C) 2019-2021 Red Hat Inc.
52

LICENSE

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