c-user: Generate message manager documentation

The documentation is a consolidation of the comments in Doxygen markup
and the documentation sources in Sphinx markup.  The documentation was
transfered to interface specification items.  The documentation source
files were generated from the items by a script.

Update #3993.
This commit is contained in:
Sebastian Huber
2021-01-15 14:08:09 +01:00
parent 61cbbd2e23
commit 63a9e0c55c
2 changed files with 1053 additions and 489 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -1,28 +1,71 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
.. generated. If you find something that needs to be fixed or
.. worded better please post a report or patch to an RTEMS mailing list
.. or raise a bug report:
..
.. https://www.rtems.org/bugs.html
..
.. For information on updating and regenerating please refer to the How-To
.. section in the Software Requirements Engineering chapter of the
.. RTEMS Software Engineering manual. The manual is provided as a part of
.. a release. For development sources please refer to the online
.. documentation at:
..
.. https://docs.rtems.org
.. Generated from spec:/rtems/message/if/group
.. _MessageManagerIntroduction:
Introduction
============
The message manager provides communication and synchronization capabilities
using RTEMS message queues. The directives provided by the message manager
are:
.. The following list was generated from:
.. spec:/rtems/message/if/create
.. spec:/rtems/message/if/construct
.. spec:/rtems/message/if/ident
.. spec:/rtems/message/if/delete
.. spec:/rtems/message/if/send
.. spec:/rtems/message/if/urgent
.. spec:/rtems/message/if/broadcast
.. spec:/rtems/message/if/receive
.. spec:/rtems/message/if/get-number-pending
.. spec:/rtems/message/if/flush
.. spec:/rtems/message/if/buffer
- :ref:`rtems_message_queue_create`
The Message Manager provides communication and synchronization capabilities
using RTEMS message queues. The directives provided by the Message Manager are:
- :ref:`rtems_message_queue_ident`
* :ref:`InterfaceRtemsMessageQueueCreate` - Creates a message queue.
- :ref:`rtems_message_queue_delete`
* :ref:`InterfaceRtemsMessageQueueConstruct` - Constructs a message queue from
the specified the message queue configuration.
- :ref:`rtems_message_queue_send`
* :ref:`InterfaceRtemsMessageQueueIdent` - Identifies a message queue by the
object name.
- :ref:`rtems_message_queue_urgent`
* :ref:`InterfaceRtemsMessageQueueDelete` - Deletes the message queue.
- :ref:`rtems_message_queue_broadcast`
* :ref:`InterfaceRtemsMessageQueueSend` - Puts the message at the rear of the
queue.
- :ref:`rtems_message_queue_receive`
* :ref:`InterfaceRtemsMessageQueueUrgent` - Puts the message at the front of
the queue.
- :ref:`rtems_message_queue_get_number_pending`
* :ref:`InterfaceRtemsMessageQueueBroadcast` - Broadcasts the messages to the
tasks waiting at the queue.
- :ref:`rtems_message_queue_flush`
* :ref:`InterfaceRtemsMessageQueueReceive` - Receives a message from the queue.
* :ref:`InterfaceRtemsMessageQueueGetNumberPending` - Gets the number of
messages pending on the queue.
* :ref:`InterfaceRtemsMessageQueueFlush` - Flushes all messages on the queue.
* :ref:`InterfaceRTEMSMESSAGEQUEUEBUFFER` - Defines a structure which can be
used as a message queue buffer for messages of the specified maximum size.