1nbd_aio_connect_uri(3) LIBNBD nbd_aio_connect_uri(3)
2
3
4
6 nbd_aio_connect_uri - connect to an NBD URI
7
9 #include <libnbd.h>
10
11 int nbd_aio_connect_uri (
12 struct nbd_handle *h, const char *uri
13 );
14
16 Begin connecting to the NBD URI "uri". Parameters behave as documented
17 in nbd_connect_uri(3).
18
19 You can check if the connection attempt is still underway by calling
20 nbd_aio_is_connecting(3). If nbd_set_opt_mode(3) is enabled, the
21 connection is ready for manual option negotiation once
22 nbd_aio_is_negotiating(3) returns true; otherwise, the connection
23 attempt will include the NBD handshake, and is ready for use once
24 nbd_aio_is_ready(3) returns true.
25
27 If the call is successful the function returns 0.
28
30 On error -1 is returned.
31
32 Refer to "ERROR HANDLING" in libnbd(3) for how to get further details
33 of the error.
34
35 The following parameters must not be NULL: "h", "uri". For more
36 information see "Non-NULL parameters" in libnbd(3).
37
39 The handle must be newly created, otherwise this call will return an
40 error.
41
43 This function first appeared in libnbd 1.0.
44
45 If you need to test if this function is available at compile time check
46 if the following macro is defined:
47
48 #define LIBNBD_HAVE_NBD_AIO_CONNECT_URI 1
49
51 nbd_aio_is_connecting(3), nbd_aio_is_negotiating(3),
52 nbd_aio_is_ready(3), nbd_connect_uri(3), nbd_create(3),
53 nbd_set_opt_mode(3), libnbd(3),
54 https://github.com/NetworkBlockDevice/nbd/blob/master/doc/uri.md.
55
57 Eric Blake
58
59 Richard W.M. Jones
60
62 Copyright Red Hat
63
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_uri(3)