1nbd_aio_disconnect(3) LIBNBD nbd_aio_disconnect(3)
2
3
4
6 nbd_aio_disconnect - disconnect from the NBD server
7
9 #include <libnbd.h>
10
11 int nbd_aio_disconnect (struct nbd_handle *h,
12 uint32_t flags);
13
15 Issue the disconnect command to the NBD server. This is not a normal
16 command because NBD servers are not obliged to send a reply. Instead
17 you should wait for nbd_aio_is_closed(3) to become true on the
18 connection. Once this command is issued, you cannot issue any further
19 commands.
20
21 Although libnbd does not prevent you from issuing this command while
22 still waiting on the replies to previous commands, the NBD protocol
23 recommends that you wait until there are no other commands in flight
24 (see nbd_aio_in_flight(3)), to give the server a better chance at a
25 clean shutdown.
26
27 The "flags" parameter must be 0 for now (it exists for future NBD
28 protocol extensions). There is no direct synchronous counterpart;
29 however, nbd_shutdown(3) will call this function if appropriate.
30
32 If the call is successful the function returns 0.
33
35 On error "-1" is returned.
36
37 Refer to "ERROR HANDLING" in libnbd(3) for how to get further details
38 of the error.
39
41 The handle must be connected with the server, otherwise this call will
42 return an error.
43
45 This function first appeared in libnbd 1.0.
46
47 If you need to test if this function is available at compile time check
48 if the following macro is defined:
49
50 #define LIBNBD_HAVE_NBD_AIO_DISCONNECT 1
51
53 nbd_aio_in_flight(3), nbd_aio_is_closed(3), nbd_create(3),
54 nbd_shutdown(3), libnbd(3).
55
57 Eric Blake
58
59 Richard W.M. Jones
60
62 Copyright (C) 2019-2021 Red Hat Inc.
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.7.12 2021-05-29 nbd_aio_disconnect(3)