NAME

       nbd_connect_vsock - connect to NBD server over AF_VSOCK protocol

SYNOPSIS

        #include <libnbd.h>

        int nbd_connect_vsock (struct nbd_handle *h, uint32_t cid,
                               uint32_t port);

DESCRIPTION

       Connect (synchronously) over the "AF_VSOCK" protocol from a virtual machine to an NBD
       server, usually running on the host.  The "cid" and "port" parameters specify the server
       address.  Usually "cid" should be 2 (to connect to the host), and "port" might be 10809 or
       another port number assigned to you by the host administrator.  This call returns when the
       connection has been made.

RETURN VALUE

       If the call is successful the function returns 0.

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 newly created, otherwise this call will return an error.

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_CONNECT_VSOCK 1

SEE ALSO

       nbd_aio_connect_vsock(3), nbd_create(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