From 6198c49c2462115f10899510e4cdf2aa81e1f504 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Tue, 14 Sep 2021 17:48:35 +0200 Subject: c-user: Fix message manager documentation Remove bogus return status from rtems_message_queue_receive(). Clarify rtems_message_queue_flush(). Close #4508. --- c-user/message/directives.rst | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) (limited to 'c-user') diff --git a/c-user/message/directives.rst b/c-user/message/directives.rst index f320350..7317eb4 100644 --- a/c-user/message/directives.rst +++ b/c-user/message/directives.rst @@ -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 `_. +.. 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 -- cgit v1.2.3