Changeset d1f19f0 in rtems

Timestamp:

Jul 31, 1997, 6:24:06 PM (24 years ago)

Author:

Joel Sherrill <joel.sherrill@…>

Branches:

4.10, 4.11, 4.8, 4.9, 5, master

Children:

c3fec1c

Parents:

e24e9b5

Message:

Added rtems_message_queue_get_number_pending directive.

File:

• doc/user/msg.t (modified) (6 diffs)

doc/user/msg.t

@@ -37 +37 @@
 @item @code{message_queue_broadcast} - Broadcast N messages to a queue
 @item @code{message_queue_receive} - Receive message from a queue
+@item @code{rtems_message_queue_get_number_pending} - Get number of messages pending on a queue
 @item @code{message_queue_flush} - Flush all messages on a queue
 @end itemize
@@ -280 +281 @@
 * MESSAGE_QUEUE_BROADCAST - Broadcast N messages to a queue::
 * MESSAGE_QUEUE_RECEIVE - Receive message from a queue::
+* MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue::
 * MESSAGE_QUEUE_FLUSH - Flush all messages on a queue::
 @end menu
@@ -692 +694 @@
 @page
 @ifinfo
-@node MESSAGE_QUEUE_RECEIVE - Receive message from a queue, MESSAGE_QUEUE_FLUSH - Flush all messages on a queue, MESSAGE_QUEUE_BROADCAST - Broadcast N messages to a queue, Message Manager Directives
+@node MESSAGE_QUEUE_RECEIVE - Receive message from a queue, MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue, MESSAGE_QUEUE_BROADCAST - Broadcast N messages to a queue, Message Manager Directives
 @end ifinfo
 @subsection MESSAGE_QUEUE_RECEIVE - Receive message from a queue
@@ -778 +780 @@
 @page
 @ifinfo
-@node MESSAGE_QUEUE_FLUSH - Flush all messages on a queue, Event Manager, MESSAGE_QUEUE_RECEIVE - Receive message from a queue, Message Manager Directives
+@node MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue, MESSAGE_QUEUE_FLUSH - Flush all messages on a queue, MESSAGE_QUEUE_RECEIVE - Receive message from a queue, Message Manager Directives
+@end ifinfo
+@subsection MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue
+
+@subheading CALLING SEQUENCE:
+
+@ifset is-C
+@example
+rtems_status_code rtems_message_queue_get_number_pending(
+  rtems_id          id,
+  rtems_unsigned32 *count
+);
+@end example
+@end ifset
+
+@ifset is-Ada
+@example
+procedure Message_Queue_Get_Number_Pending (
+   ID     : in     RTEMS.ID;
+   Count  :    out RTEMS.Unsigned32;
+   Result :    out RTEMS.Status_Codes
+);
+@end example
+@end ifset
+
+@subheading DIRECTIVE STATUS CODES:
+@code{SUCCESSFUL} - number of messages pending returned successfully@*
+@code{INVALID_ID} - invalid queue id
+
+@subheading DESCRIPTION:
+
+This directive returns the number of messages pending on this
+message queue in count.  If no messages are present
+on the queue, count is set to zero.
+
+@subheading NOTES:
+
+Getting the number of pending messages on a global message queue which
+does not reside on the local node will generate a request to the
+remote node to actually obtain the pending message count for
+the specified message queue.
+
+
+@page
+@ifinfo
+@node MESSAGE_QUEUE_FLUSH - Flush all messages on a queue, Event Manager, MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue, Message Manager Directives
 @end ifinfo
 @subsection MESSAGE_QUEUE_FLUSH - Flush all messages on a queue
@@ -804 +851 @@
 
 @subheading DIRECTIVE STATUS CODES:
-@code{SUCCESSFUL} - message received successfully@*
+@code{SUCCESSFUL} - message queue flushed successfully@*
 @code{INVALID_ID} - invalid queue id
 
@@ -820 +867 @@
 remote node to actually flush the specified message queue.
 
-
-