NAME¶

nbd_get_handshake_flags - see which handshake flags are supported

SYNOPSIS¶

 #include <libnbd.h>
 uint32_t nbd_get_handshake_flags (struct nbd_handle *h);

DESCRIPTION¶

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

RETURN VALUE¶

This call returns a bitmask of LIBNBD_HANDSHAKE_FLAG_* values.

ERRORS¶

This function does not fail.

The following parameters must not be NULL: "h". For more information see "Non-NULL parameters" in libnbd(3).

VERSION¶

This function first appeared in libnbd 1.2.

If you need to test if this function is available at compile time check if the following macro is defined:

 #define LIBNBD_HAVE_NBD_GET_HANDSHAKE_FLAGS 1

SEE ALSO¶

nbd_aio_is_created(3), nbd_aio_is_ready(3), nbd_create(3), nbd_get_protocol(3), nbd_set_handshake_flags(3), nbd_set_strict_mode(3), libnbd(3).

AUTHORS¶

Eric Blake

Richard W.M. Jones

COPYRIGHT¶

Copyright (C) 2019-2021 Red Hat Inc.

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.

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.

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