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: No need for system-wide uniqueness

Browse Source
This commit is contained in:
chrysn 2022-01-05 19:34:15 +01:00
parent 79e0e94312
commit 4bbe0ec42d
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
core/include/msg.h
View File

@ -15,9 +15,20 @@
* ========
* IPC messages consist of a sender PID, a type, and some content. The sender
* PID will be set by the IPC internally and is not required to be set by the
* user. The type helps the receiver to multiplex different message types and
* should be set to a system-wide unique value. The content can either be
* provided as a 32-bit integer or a pointer.
* user. The type helps the receiver to multiplex different message types.
* The content can either be provided as a 32-bit integer or a pointer.
*
* Some message types are predefined; for example, @ref
* GNRC_NETAPI_MSG_TYPE_RCV & co are defined. These are fixed in the sense that
* registering for a particular set of messages (for the above, e.g. @ref
* gnrc_netreg_register) will use these message types. Threads that do nothing
* to receive such messages can safely use the same numbers for other purposes.
* The predefined types use non-conflicting ranges (e.g. `0x02NN`) to avoid
* ruling out simultaneous use of different components in the same thread.
*
* In general, threads may consider it an error to send them a message they did
* not request. Best practice is to log (but otherwise ignore) unexpected
* messages.
*
* Blocking vs non-blocking
* ========================