RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

core/msg doc: Clarify; elaborating on interaction with queue

Browse Source
This commit is contained in:
chrysn 2021-09-01 14:56:41 +02:00
parent db16cafe04
commit 137399c8cb
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
core/include/msg.h
View File

@ -311,7 +311,13 @@ int msg_try_receive(msg_t *m);
* @brief Send a message, block until reply received.
*
* This function sends a message to *target_pid* and then blocks until target
* has sent a reply which is then stored in *reply*.
* has sent a reply which is then stored in *reply*. The responding thread must
* use @ref msg_reply().
*
* Any incoming messages other than the reply are put into the queue (if one is
* configured), block the sender (if sent with @ref msg_send from a thread), or
* rejected (if sent with @ref msg_try_send or from an interrupt) -- just like
* if the thread were blocked on anything different than message reception.
*
* @pre @p target_pid is not the PID of the current thread.
*