1nbd_aio_command_completed(3)        LIBNBD        nbd_aio_command_completed(3)
2
3
4

NAME

6       nbd_aio_command_completed - check if the command completed
7

SYNOPSIS

9        #include <libnbd.h>
10
11        int nbd_aio_command_completed (struct nbd_handle *h,
12                                       uint64_t cookie);
13

DESCRIPTION

15       Return true if the command completed.  If this function returns true
16       then the command was successful and it has been retired.  Return false
17       if the command is still in flight.  This can also fail with an error in
18       case the command failed (in this case the command is also retired).  A
19       command is retired either via this command, or by using a completion
20       callback which returns 1.
21
22       The "cookie" parameter is the positive unique 64 bit cookie for the
23       command, as returned by a call such as nbd_aio_pread(3).
24

RETURN VALUE

26       This call returns a boolean value.
27

ERRORS

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

VERSION

38       This function first appeared in libnbd 1.0.
39
40       If you need to test if this function is available at compile time check
41       if the following macro is defined:
42
43        #define LIBNBD_HAVE_NBD_AIO_COMMAND_COMPLETED 1
44

SEE ALSO

46       nbd_aio_pread(3), nbd_create(3), libnbd(3).
47

AUTHORS

49       Eric Blake
50
51       Richard W.M. Jones
52

54       Copyright (C) 2019-2021 Red Hat Inc.
55

LICENSE

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