Skip to content
Permalink
Browse files

doc: clarify behavior of k_poll_signal_raise on error

k_poll_signal_raise() returns an error code to indicate that the raise
was too late to notify an expiring poll.  Make clear that this does not
mean that the signal was lost: a subsequent poll will find it and expire
immediately.

Signed-off-by: Peter A. Bigot <pab@pabigot.com>
  • Loading branch information...
pabigot authored and nashif committed Apr 30, 2019
1 parent a404bb7 commit 773bd98c73cf6e2ab486c404928477b76bd125f0
Showing with 4 additions and 0 deletions.
  1. +4 −0 include/kernel.h
@@ -4429,6 +4429,10 @@ __syscall void k_poll_signal_check(struct k_poll_signal *signal,
* passed again to k_poll() or k_poll() will consider it being signaled, and
* will return immediately.
*
* @note The result is stored and the 'signaled' field is set even if
* this function returns an error indicating that an expiring poll was
* not notified. The next k_poll() will detect the missed raise.
*
* @param signal A poll signal.
* @param result The value to store in the result field of the signal.
*

0 comments on commit 773bd98

Please sign in to comment.
You can’t perform that action at this time.