1nbd_aio_disconnect(3)               LIBNBD               nbd_aio_disconnect(3)
2
3
4

NAME

6       nbd_aio_disconnect - disconnect from the NBD server
7

SYNOPSIS

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

DESCRIPTION

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

RETURN VALUE

32       If the call is successful the function returns 0.
33

ERRORS

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
40       The following parameters must not be NULL: "h".  For more information
41       see "Non-NULL parameters" in libnbd(3).
42

HANDLE STATE

44       The handle must be connected with the server, otherwise this call will
45       return an error.
46

VERSION

48       This function first appeared in libnbd 1.0.
49
50       If you need to test if this function is available at compile time check
51       if the following macro is defined:
52
53        #define LIBNBD_HAVE_NBD_AIO_DISCONNECT 1
54

SEE ALSO

56       nbd_aio_in_flight(3), nbd_aio_is_closed(3), nbd_create(3),
57       nbd_shutdown(3), libnbd(3).
58

AUTHORS

60       Eric Blake
61
62       Richard W.M. Jones
63

65       Copyright (C) 2019-2021 Red Hat Inc.
66

LICENSE

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