1nbd_connect_vsock(3)                LIBNBD                nbd_connect_vsock(3)
2
3
4

NAME

6       nbd_connect_vsock - connect to NBD server over AF_VSOCK protocol
7

SYNOPSIS

9        #include <libnbd.h>
10
11        int nbd_connect_vsock (struct nbd_handle *h, uint32_t cid,
12                               uint32_t port);
13

DESCRIPTION

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

RETURN VALUE

23       If the call is successful the function returns 0.
24

ERRORS

26       On error "-1" is returned.
27
28       Refer to "ERROR HANDLING" in libnbd(3) for how to get further details
29       of the error.
30
31       The following parameters must not be NULL: "h".  For more information
32       see "Non-NULL parameters" in libnbd(3).
33

HANDLE STATE

35       The handle must be newly created, otherwise this call will return an
36       error.
37

VERSION

39       This function first appeared in libnbd 1.2.
40
41       If you need to test if this function is available at compile time check
42       if the following macro is defined:
43
44        #define LIBNBD_HAVE_NBD_CONNECT_VSOCK 1
45

SEE ALSO

47       nbd_aio_connect_vsock(3), nbd_create(3), libnbd(3).
48

AUTHORS

50       Eric Blake
51
52       Richard W.M. Jones
53

55       Copyright (C) 2019-2021 Red Hat Inc.
56

LICENSE

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