Commit 4404da7c authored by Yanbo Zhou's avatar Yanbo Zhou Committed by Jim Harris
Browse files

include/blob.h: add comments for callback functions 



Change-Id: I984b70c47d4ec465775994945ea6ba588a0aed2b
Signed-off-by: default avatarYanbo Zhou <yanbo.zhou@intel.com>
Reviewed-on: https://review.gerrithub.io/407684


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarGangCao <gang.cao@intel.com>
Reviewed-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
parent 01a9118d

include/spdk/blob.h

+44 −4
Original line number Diff line number Diff line
@@ -75,17 +75,57 @@ struct spdk_io_channel; 
struct spdk_blob;

struct spdk_xattr_names;



/**

 * Blobstore operation completion callback.

 *

 * \param cb_arg Callback argument.

 * \param bserrno 0 if it completed successfully, or negative errno if it failed.

 */

typedef void (*spdk_bs_op_complete)(void *cb_arg, int bserrno);



/**

 * Blobstore operation completion callback with handle.

 *

 * \param cb_arg Callback argument.

 * \param bs Handle to a blobstore.

 * \param bserrno 0 if it completed successfully, or negative errno if it failed.

 */

typedef void (*spdk_bs_op_with_handle_complete)(void *cb_arg, struct spdk_blob_store *bs,

		int bserrno);



/**

 * Blob operation completion callback.

 *

 * \param cb_arg Callback argument.

 * \param bserrno 0 if it completed successfully, or negative errno if it failed.

 */

typedef void (*spdk_blob_op_complete)(void *cb_arg, int bserrno);



/**

 * Blob operation completion callback with blob ID.

 *

 * \param cb_arg Callback argument.

 * \param blobid Blob ID.

 * \param bserrno 0 if it completed successfully, or negative errno if it failed.

 */

typedef void (*spdk_blob_op_with_id_complete)(void *cb_arg, spdk_blob_id blobid, int bserrno);

typedef void (*spdk_blob_op_with_handle_complete)(void *cb_arg, struct spdk_blob *blb, int bserrno);



/**

 * Blob operation completion callback with handle.

 *

 * \param cb_arg Callback argument.

 * \param bs Handle to a blob.

 * \param bserrno 0 if it completed successfully, or negative errno if it failed.

 */

typedef void (*spdk_blob_op_with_handle_complete)(void *cb_arg, struct spdk_blob *blb, int bserrno);



/* Calls to function pointers of this type must obey all of the normal

   rules for channels. The channel passed to this completion must match

   the channel the operation was initiated on. */

/**

 * Blobstore device completion callback.

 *

 * \param channel I/O channel the operation was initiated on.

 * \param cb_arg Callback argument.

 * \param bserrno 0 if it completed successfully, or negative errno if it failed.

 */

typedef void (*spdk_bs_dev_cpl)(struct spdk_io_channel *channel,

				void *cb_arg, int bserrno);