1nbd_aio_connect_vsock(3)            LIBNBD            nbd_aio_connect_vsock(3)
2
3
4

NAME

6       nbd_aio_connect_vsock - connect to the NBD server over AF_VSOCK socket
7

SYNOPSIS

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

DESCRIPTION

16       Begin connecting to the NBD server over the "AF_VSOCK" protocol to the
17       server "cid:port".  Parameters behave as documented in
18       nbd_connect_vsock(3).
19
20       You can check if the connection attempt is still underway by calling
21       nbd_aio_is_connecting(3).  If nbd_set_opt_mode(3) is enabled, the
22       connection is ready for manual option negotiation once
23       nbd_aio_is_negotiating(3) returns true; otherwise, the connection
24       attempt will include the NBD handshake, and is ready for use once
25       nbd_aio_is_ready(3) returns true.
26

RETURN VALUE

28       If the call is successful the function returns 0.
29

ERRORS

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

HANDLE STATE

40       The handle must be newly created, otherwise this call will return an
41       error.
42

VERSION

44       This function first appeared in libnbd 1.2.
45
46       If you need to test if this function is available at compile time check
47       if the following macro is defined:
48
49        #define LIBNBD_HAVE_NBD_AIO_CONNECT_VSOCK 1
50

SEE ALSO

52       nbd_aio_is_connecting(3), nbd_aio_is_negotiating(3),
53       nbd_aio_is_ready(3), nbd_connect_vsock(3), nbd_create(3),
54       nbd_set_opt_mode(3), libnbd(3).
55

AUTHORS

57       Eric Blake
58
59       Richard W.M. Jones
60

62       Copyright Red Hat
63

LICENSE

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