RTEMS 4.8.0 On-Line Library

Message Manager MESSAGE_QUEUE_FLUSH - Flush all messages on a queue

RTEMS C User's Guide

10.4.9: MESSAGE_QUEUE_FLUSH - Flush all messages on a queue

CALLING SEQUENCE:

rtems_status_code rtems_message_queue_flush(
  rtems_id  id,
  uint32_t *count
);

DIRECTIVE STATUS CODES:

RTEMS_SUCCESSFUL - message queue flushed successfully
RTEMS_INVALID_ADDRESS - count is NULL
RTEMS_INVALID_ID - invalid queue id

DESCRIPTION:

This directive removes all pending messages from the specified queue id. The number of messages removed is returned in count. If no messages are present on the queue, count is set to zero.

NOTES:

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.

RTEMS C User's Guide