1nbd_aio_connect(3)                  LIBNBD                  nbd_aio_connect(3)
2
3
4

NAME

6       nbd_aio_connect - connect to the NBD server
7

SYNOPSIS

9        #include <libnbd.h>
10
11        int nbd_aio_connect (
12              struct nbd_handle *h, const struct sockaddr *addr,
13              socklen_t addrlen
14            );
15

DESCRIPTION

17       Begin connecting to the NBD server.  The "addr" and "addrlen"
18       parameters specify the address of the socket to connect to.
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", "addr".  For more
37       information 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.0.
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 1
50

SEE ALSO

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

AUTHORS

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

61       Copyright Red Hat
62

LICENSE

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