rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-06-02 10:13:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

c-user: Fix message manager documentation

Browse Source 
Remove bogus return status from rtems_message_queue_receive().  Clarify
rtems_message_queue_flush().

Close #4508.
This commit is contained in:
Sebastian Huber 2021-09-14 17:48:35 +02:00
parent 0bc62eee95
commit 6198c49c24
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
c-user/message/directives.rst
View File

@ -891,10 +891,6 @@ queue.
:c:macro:`RTEMS_UNSATISFIED`
The queue was empty.
:c:macro:`RTEMS_UNSATISFIED`
The queue was flushed while the calling task was waiting to receive a
message.
:c:macro:`RTEMS_TIMEOUT`
The timeout happened while the calling task was waiting to receive a
message
@ -1039,17 +1035,22 @@ present on the queue, count is set to zero.
The ``count`` parameter was `NULL
<https://en.cppreference.com/w/c/types/NULL>`_.
.. rubric:: NOTES:
The directive does not flush tasks waiting to receive a message from the
:term:`wait queue` of the message queue.
.. rubric:: CONSTRAINTS:
The following constraints apply to this directive:
* The directive may be called from within task context.
* The directive may be called from within interrupt context.
* When the directive operates on a remote object, the directive sends a message
to the remote node and waits for a reply. This will preempt the calling
task.
* The directive may be called from within device driver initialization context.
* The directive may be called from within task context.
* The directive will not cause the calling task to be preempted.
.. Generated from spec:/rtems/message/if/buffer