ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

lib/thread: Update comment for spdk_thread_poll about thread exiting

Browse Source 
Remove the description "return -1 if thread has exited" and add
the description "If the thread has exited, return immediately" instead.

Signed-off-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Change-Id: If4b4b565dc7aa1261fa7c3fdfb73cfc814e38d5d
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/478385
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
This commit is contained in:
Shuhei Matsumoto 2019-12-18 17:05:50 -05:00 committed by Tomasz Zawadzki
parent 876fdf2a59
commit 43d7867243
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
include/spdk/thread.h
View File

@ -272,7 +272,8 @@ struct spdk_thread *spdk_thread_get_from_ctx(void *ctx);
/**
* Perform one iteration worth of processing on the thread. This includes
* both expired and continuous pollers as well as messages.
* both expired and continuous pollers as well as messages. If the thread
* has exited, return immediately.
*
* \param thread The thread to process
* \param max_msgs The maximum number of messages that will be processed.
@ -280,7 +281,7 @@ struct spdk_thread *spdk_thread_get_from_ctx(void *ctx);
* \param now The current time, in ticks. Optional. If 0 is passed, this
* function may call spdk_get_ticks() to get the current time.
*
* \return 1 if work was done. 0 if no work was done. -1 if thread has exited.
* \return 1 if work was done. 0 if no work was done.
*/
int spdk_thread_poll(struct spdk_thread *thread, uint32_t max_msgs, uint64_t now);