NAME

nbd_can_meta_context - does the server support a specific meta context?

SYNOPSIS

 #include <libnbd.h>

 int nbd_can_meta_context (struct nbd_handle *h,
                           const char *metacontext);

DESCRIPTION

Returns true if the server supports the given meta context (see nbd_add_meta_context(3)). Returns false if the server does not.

The single parameter is the name of the metadata context, for example LIBNBD_CONTEXT_BASE_ALLOCATION. <libnbd.h> includes defined constants for well-known namespace contexts beginning with LIBNBD_CONTEXT_, but you are free to pass in other contexts.

This call does not block, because it returns data that is saved in the handle from the NBD protocol handshake.

RETURN VALUE

This call returns a boolean value.

ERRORS

On error -1 is returned.

Refer to "ERROR HANDLING" in libnbd(3) for how to get further details of the error.

HANDLE STATE

The handle must be connected and finished handshaking with the server, or shut down, otherwise this call will return an error.

VERSION

This function first appeared in libnbd 1.0.

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

 #define LIBNBD_HAVE_NBD_CAN_META_CONTEXT 1

SEE ALSO

nbd_add_meta_context(3), nbd_aio_block_status(3), nbd_block_status(3), nbd_create(3), "Flag calls" in libnbd(3), libnbd(3).

AUTHORS

Eric Blake

Richard W.M. Jones

COPYRIGHT

Copyright (C) 2019-2020 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