summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>1997-07-31 18:24:06 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>1997-07-31 18:24:06 +0000
commitd1f19f09db28e91c2bf1a613b95ebc5beb8911f8 (patch)
treef93adb8cf4e91b8bd75e6ce3ecacbee75d58c489
parente24e9b5ba5e9923c889959c0df2961606b6167e0 (diff)
downloadrtems-d1f19f09db28e91c2bf1a613b95ebc5beb8911f8.tar.bz2
Added rtems_message_queue_get_number_pending directive.
-rw-r--r--doc/user/msg.t55
1 files changed, 50 insertions, 5 deletions
diff --git a/doc/user/msg.t b/doc/user/msg.t
index f4e83c5e9d..906b80cff7 100644
--- a/doc/user/msg.t
+++ b/doc/user/msg.t
@@ -36,6 +36,7 @@ directives provided by the message manager are:
@item @code{message_queue_urgent} - Put message at front of a queue
@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
@@ -279,6 +280,7 @@ at the message queue are also deleted and deallocated.
* MESSAGE_QUEUE_URGENT - Put message at front of a queue::
* 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
@end ifinfo
@@ -691,7 +693,7 @@ proxy used to represent the task is reclaimed.
@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
@@ -777,7 +779,52 @@ message is posted.
@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
@@ -803,7 +850,7 @@ procedure Message_Queue_Flush (
@end ifset
@subheading DIRECTIVE STATUS CODES:
-@code{SUCCESSFUL} - message received successfully@*
+@code{SUCCESSFUL} - message queue flushed successfully@*
@code{INVALID_ID} - invalid queue id
@subheading DESCRIPTION:
@@ -819,5 +866,3 @@ Flushing all messages on a global message queue which
does not reside on the local node will generate a request to the
remote node to actually flush the specified message queue.
-
-