Changeset d1f19f0 in rtems


Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user/msg.t

    re24e9b5 rd1f19f0  
    3737@item @code{message_queue_broadcast} - Broadcast N messages to a queue
    3838@item @code{message_queue_receive} - Receive message from a queue
     39@item @code{rtems_message_queue_get_number_pending} - Get number of messages pending on a queue
    3940@item @code{message_queue_flush} - Flush all messages on a queue
    4041@end itemize
     
    280281* MESSAGE_QUEUE_BROADCAST - Broadcast N messages to a queue::
    281282* MESSAGE_QUEUE_RECEIVE - Receive message from a queue::
     283* MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue::
    282284* MESSAGE_QUEUE_FLUSH - Flush all messages on a queue::
    283285@end menu
     
    692694@page
    693695@ifinfo
    694 @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
     696@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
    695697@end ifinfo
    696698@subsection MESSAGE_QUEUE_RECEIVE - Receive message from a queue
     
    778780@page
    779781@ifinfo
    780 @node MESSAGE_QUEUE_FLUSH - Flush all messages on a queue, Event Manager, MESSAGE_QUEUE_RECEIVE - Receive message from a queue, Message Manager Directives
     782@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
     783@end ifinfo
     784@subsection MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue
     785
     786@subheading CALLING SEQUENCE:
     787
     788@ifset is-C
     789@example
     790rtems_status_code rtems_message_queue_get_number_pending(
     791  rtems_id          id,
     792  rtems_unsigned32 *count
     793);
     794@end example
     795@end ifset
     796
     797@ifset is-Ada
     798@example
     799procedure Message_Queue_Get_Number_Pending (
     800   ID     : in     RTEMS.ID;
     801   Count  :    out RTEMS.Unsigned32;
     802   Result :    out RTEMS.Status_Codes
     803);
     804@end example
     805@end ifset
     806
     807@subheading DIRECTIVE STATUS CODES:
     808@code{SUCCESSFUL} - number of messages pending returned successfully@*
     809@code{INVALID_ID} - invalid queue id
     810
     811@subheading DESCRIPTION:
     812
     813This directive returns the number of messages pending on this
     814message queue in count.  If no messages are present
     815on the queue, count is set to zero.
     816
     817@subheading NOTES:
     818
     819Getting the number of pending messages on a global message queue which
     820does not reside on the local node will generate a request to the
     821remote node to actually obtain the pending message count for
     822the specified message queue.
     823
     824
     825@page
     826@ifinfo
     827@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
    781828@end ifinfo
    782829@subsection MESSAGE_QUEUE_FLUSH - Flush all messages on a queue
     
    804851
    805852@subheading DIRECTIVE STATUS CODES:
    806 @code{SUCCESSFUL} - message received successfully@*
     853@code{SUCCESSFUL} - message queue flushed successfully@*
    807854@code{INVALID_ID} - invalid queue id
    808855
     
    820867remote node to actually flush the specified message queue.
    821868
    822 
    823 
Note: See TracChangeset for help on using the changeset viewer.