RTEMS 4.9.2 On-Line Library

Message Manager MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue

RTEMS Ada User's Guide

10.4.8: MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue

CALLING SEQUENCE:

procedure Message_Queue_Get_Number_Pending (
   ID     : in     RTEMS.ID;
   Count  :    out RTEMS.Unsigned32;
   Result :    out RTEMS.Status_Codes
);

DIRECTIVE STATUS CODES:

RTEMS.SUCCESSFUL - number of messages pending returned successfully
RTEMS.INVALID_ADDRESS - count is NULL
RTEMS.INVALID_ID - invalid queue id

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.

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.

RTEMS Ada User's Guide