Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: make the 2^x requirement for msg_queue more visible #6003

Merged
merged 1 commit into from
Nov 1, 2016
Merged

doc: make the 2^x requirement for msg_queue more visible #6003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions core/include/msg.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,11 @@
* Asynchronous IPC
* ----------------
* To use asynchronous IPC one needs to initialize a message queue using
* @ref msg_init_queue(). Messages sent to a thread with a message queue that
* isn't full are never dropped and the sending never blocks, even when using
* @ref msg_send(). If the queue is full and the sending thread has a higher
* priority than the receiving thread the send-behavior is equivalent to
* synchronous mode.
* @ref msg_init_queue() (note that it **must** be of a size equal to a power of
* two). Messages sent to a thread with a message queue that isn't full are
* never dropped and the sending never blocks, even when using @ref msg_send().
* If the queue is full and the sending thread has a higher priority than the
* receiving thread the send-behavior is equivalent to synchronous mode.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~ {.c}
* #include <inttypes.h>
Expand Down Expand Up @@ -365,6 +365,8 @@ int msg_avail(void);
/**
* @brief Initialize the current thread's message queue.
*
* @pre @p num **MUST BE A POWER OF TWO!**
*
* @param[in] array Pointer to preallocated array of ``msg_t`` structures, must
* not be NULL.
* @param[in] num Number of ``msg_t`` structures in array.
Expand Down
3 changes: 2 additions & 1 deletion sys/include/net/gnrc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@
* Hence, a thread for @ref net_gnrc "GNRC" will usually consist of four basic
* steps.
*
* 1. Initialize a message queue
* 1. Initialize a message queue (note that its size **must** be a power of two,
* see @ref msg_init_queue())
* 2. register for a @ref net_gnrc_nettype
* 3. wait for a message
* 4. react appropriately to a message and return to 3.
Expand Down