nbd_aio_command_completed - Man Page

check if the command completed

Synopsis

 #include <libnbd.h>

 int nbd_aio_command_completed (struct nbd_handle *h,
                                uint64_t cookie);

Description

Return true if the command completed.  If this function returns true then the command was successful and it has been retired. Return false if the command is still in flight.  This can also fail with an error in case the command failed (in this case the command is also retired).  A command is retired either via this command, or by using a completion callback which returns 1.

The cookie parameter is the positive unique 64 bit cookie for the command, as returned by a call such as nbd_aio_pread(3).

Return Value

This call returns a boolean value.

Errors

On error -1 is returned.

Refer to “ERROR HANDLING” in libnbd(3) for how to get further details of the error.

Version

This function first appeared in libnbd 1.0.

If you need to test if this function is available at compile time check if the following macro is defined:

 #define LIBNBD_HAVE_NBD_AIO_COMMAND_COMPLETED 1

See Also

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

Authors

Eric Blake

Richard W.M. Jones

License

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Referenced By

libnbd(3), NBD(3), nbd_aio_block_status(3), nbd_aio_cache(3), nbd_aio_flush(3), nbd_aio_in_flight(3), nbd_aio_peek_command_completed(3), nbd_aio_pread(3), nbd_aio_pread_structured(3), nbd_aio_pwrite(3), nbd_aio_trim(3), nbd_aio_zero(3), nbd_create(3).

2020-10-05 libnbd-1.5.4