From ed97638ccd6dda946eb9f628ed7a2537b2b6841a Mon Sep 17 00:00:00 2001 From: Yanbo Zhou Date: Mon, 16 Apr 2018 16:43:19 +0800 Subject: [PATCH] include/nvmf.h: add comments for callback functions Change-Id: I85932db79323de7bb7707a2c8ab0d205f3671629 Signed-off-by: Yanbo Zhou Reviewed-on: https://review.gerrithub.io/407714 Tested-by: SPDK Automated Test System Reviewed-by: Ben Walker Reviewed-by: Shuhei Matsumoto --- include/spdk/nvmf.h | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/include/spdk/nvmf.h b/include/spdk/nvmf.h index 81187aa26..ea8337aa0 100644 --- a/include/spdk/nvmf.h +++ b/include/spdk/nvmf.h @@ -92,6 +92,12 @@ struct spdk_nvmf_tgt *spdk_nvmf_tgt_create(struct spdk_nvmf_tgt_opts *opts); */ void spdk_nvmf_tgt_destroy(struct spdk_nvmf_tgt *tgt); +/** + * Function to be called once the target is listening. + * + * \param ctx Context argument passed to this function. + * \param status 0 if it completed successfully, or negative errno if it failed. + */ typedef void (*spdk_nvmf_tgt_listen_done_fn)(void *ctx, int status); /** @@ -114,6 +120,11 @@ void spdk_nvmf_tgt_listen(struct spdk_nvmf_tgt *tgt, spdk_nvmf_tgt_listen_done_fn cb_fn, void *cb_arg); +/** + * Function to be called for each newly discovered qpair. + * + * \param qpair The newly discovered qpair. + */ typedef void (*new_qpair_fn)(struct spdk_nvmf_qpair *qpair); /** @@ -195,6 +206,13 @@ struct spdk_nvmf_subsystem *spdk_nvmf_subsystem_create(struct spdk_nvmf_tgt *tgt */ void spdk_nvmf_subsystem_destroy(struct spdk_nvmf_subsystem *subsystem); +/** + * Function to be called once the subsystem has changed state. + * + * \param subsytem NVMe-oF subsystem that has changed state. + * \param cb_arg Argument passed to callback function. + * \param status 0 if it completed successfully, or negative errno if it failed. + */ typedef void (*spdk_nvmf_subsystem_state_change_done)(struct spdk_nvmf_subsystem *subsystem, void *cb_arg, int status);