Commit d7886cf3 authored by Jacek Kalwas's avatar Jacek Kalwas Committed by Jim Harris
Browse files

thread: improve spdk_iobuf_get API description 



It is matching implementation now.

Change-Id: I62005d17a1b4c4b396c67804da5eab94bbdb8248
Signed-off-by: default avatarJacek Kalwas <jacek.kalwas@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/22002


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@nvidia.com>
Community-CI: Mellanox Build Bot
Reviewed-by: default avatarJim Harris <jim.harris@samsung.com>
parent ba58dd60

include/spdk/thread.h

+6 −6
Original line number Diff line number Diff line
@@ -1156,15 +1156,15 @@ void spdk_iobuf_entry_abort(struct spdk_iobuf_channel *ch, struct spdk_iobuf_ent 
			    uint64_t len);



/**

 * Get a buffer from the iobuf pool.  If no buffers are available, the request is queued until a

 * buffer is released.

 * Get a buffer from the iobuf pool. If no buffers are available and entry with cb_fn provided

 * then the request is queued until a buffer becomes available.

 *

 * \param ch iobuf channel.

 * \param len Length of the buffer to retrieve. The user is responsible for making sure the length

 *            doesn't exceed large_bufsize.

 * \param entry Wait queue entry.

 * \param entry Wait queue entry (optional).

 * \param cb_fn Callback to be executed once a buffer becomes available. If a buffer is available

 *              immediately, it is NOT be executed.

 *              immediately, it is NOT executed. Mandatory only if entry provided.

 *

 * \return pointer to a buffer or NULL if no buffers are currently available.

 */