Commit 893ad788 authored by Jim Harris's avatar Jim Harris
Browse files

blob: clarify that the blob is open in the iter_cb 



Signed-off-by: default avatarJim Harris <james.r.harris@intel.com>
Change-Id: I543c3c2d54967884d704fc80214f0a1d6aa2db60
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/11355


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Reviewed-by: default avatarPaul Luse <paul.e.luse@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
parent af1c4f7f

include/spdk/blob.h

+14 −0
Original line number Diff line number Diff line
@@ -809,6 +809,13 @@ void spdk_blob_io_write_zeroes(struct spdk_blob *blob, struct spdk_io_channel *c 
 * Get the first blob of the blobstore. The obtained blob will be passed to

 * the callback function.

 *

 * The user's cb_fn will be called with rc == -ENOENT when the iteration is

 * complete.

 *

 * When the user's cb_fn is called with rc == 0, the associated blob is open.

 * This means that the cb_fn may not attempt to unload the blobstore.  It

 * must complete the iteration before attempting to unload.

 *

 * \param bs blobstore to traverse.

 * \param cb_fn Called when the operation is complete.

 * \param cb_arg Argument passed to function cb_fn.
@@ -820,6 +827,13 @@ void spdk_bs_iter_first(struct spdk_blob_store *bs, 
 * Get the next blob by using the current blob. The obtained blob will be passed

 * to the callback function.

 *

 * The user's cb_fn will be called with rc == -ENOENT when the iteration is

 * complete.

 *

 * When the user's cb_fn is called with rc == 0, the associated blob is open.

 * This means that the cb_fn may not attempt to unload the blobstore.  It

 * must complete the iteration before attempting to unload.

 *

 * \param bs blobstore to traverse.

 * \param blob The current blob.

 * \param cb_fn Called when the operation is complete.