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

include/nvmf.h: add comments for callback functions 



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


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
parent c9476f1b

include/spdk/nvmf.h

+18 −0
Original line number Diff line number Diff line
@@ -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);