nbd_supports_vsock(3)               LIBNBD               nbd_supports_vsock(3)


NAME
       nbd_supports_vsock - true if libnbd was compiled with support for
       AF_VSOCK

SYNOPSIS
        #include <libnbd.h>

        int nbd_supports_vsock (
              struct nbd_handle *h
            );

DESCRIPTION
       Returns true if libnbd was compiled with support for the "AF_VSOCK"
       family of sockets, or false if not.

       Note that on the Linux operating system, this returns true if there is
       compile-time support, but you may still need runtime support for some
       aspects of AF_VSOCK usage; for example, use of "VMADDR_CID_LOCAL" as
       the server name requires that the vsock_loopback kernel module is
       loaded.

RETURN VALUE
       This call returns a boolean value.

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.16.

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

        #define LIBNBD_HAVE_NBD_SUPPORTS_VSOCK 1

SEE ALSO
       nbd_connect_uri(3), nbd_connect_vsock(3), nbd_create(3), libnbd(3).

AUTHORS
       Eric Blake

       Richard W.M. Jones

COPYRIGHT
       Copyright Red Hat

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

libnbd-1.20.0                     2024-05-31             nbd_supports_vsock(3)