diff options
Diffstat (limited to 'cpukit/posix/include/rtems/posix/mqueue.h')
| -rw-r--r-- | cpukit/posix/include/rtems/posix/mqueue.h | 58 |
1 files changed, 52 insertions, 6 deletions
diff --git a/cpukit/posix/include/rtems/posix/mqueue.h b/cpukit/posix/include/rtems/posix/mqueue.h index ea94669e71..582d5b73b2 100644 --- a/cpukit/posix/include/rtems/posix/mqueue.h +++ b/cpukit/posix/include/rtems/posix/mqueue.h @@ -3,6 +3,18 @@ * * This include file contains all the private support information for * POSIX Message Queues. + * + * The structure of the routines is identical to that of POSIX + * Message_queues to leave the option of having unnamed message + * queues at a future date. They are currently not part of the + * POSIX standard but unnamed message_queues are. This is also + * the reason for the apparently unnecessary tracking of + * the process_shared attribute. [In addition to the fact that + * it would be trivial to add pshared to the mq_attr structure + * and have process private message queues.] + * + * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open + * time. */ /* @@ -23,10 +35,20 @@ #include <rtems/score/object.h> #include <rtems/posix/posixapi.h> +/** + * @defgroup POSIX_MQUEUE_P Message Queues Private Support Information + * + * @ingroup POSIX + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif +/** + * @ingroup POSIX_MQUEUE + */ + /* * Data Structure used to manage a POSIX message queue */ @@ -57,11 +79,24 @@ POSIX_EXTERN Objects_Information _POSIX_Message_queue_Information; POSIX_EXTERN Objects_Information _POSIX_Message_queue_Information_fds; /* - * _POSIX_Message_queue_Manager_initialization + * @brief Initializes message_queue Manager Related Data Structures * * DESCRIPTION: * * This routine performs the initialization necessary for this manager. + * + * NOTE: The structure of the routines is identical to that of POSIX + * Message_queues to leave the option of having unnamed message + * queues at a future date. They are currently not part of the + * POSIX standard but unnamed message_queues are. This is also + * the reason for the apparently unnecessary tracking of + * the process_shared attribute. [In addition to the fact that + * it would be trivial to add pshared to the mq_attr structure + * and have process private message queues.] + * + * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open + * time. + * */ void _POSIX_Message_queue_Manager_initialization(void); @@ -84,25 +119,36 @@ int _POSIX_Message_queue_Create_support( POSIX_Message_queue_Control **message_queue ); -/* - * _POSIX_Message_queue_Delete +/** + * @brief POSIX Delete Message Queue * * DESCRIPTION: * * This routine supports the mq_unlink and mq_close routines by * doing most of the work involved with removing a message queue. */ - void _POSIX_Message_queue_Delete( POSIX_Message_queue_Control *the_mq ); /* - * _POSIX_Message_queue_Receive_support + * @brief POSIX Message Queue Receive Support * * DESCRIPTION: * * This routine supports the various flavors of receiving a message. + * + * NOTE: The structure of the routines is identical to that of POSIX + * Message_queues to leave the option of having unnamed message + * queues at a future date. They are currently not part of the + * POSIX standard but unnamed message_queues are. This is also + * the reason for the apparently unnecessary tracking of + * the process_shared attribute. [In addition to the fact that + * it would be trivial to add pshared to the mq_attr structure + * and have process private message queues.] + * + * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open + * time. */ ssize_t _POSIX_Message_queue_Receive_support( @@ -228,6 +274,6 @@ int _POSIX_Message_queue_Translate_core_message_queue_return_code( #ifdef __cplusplus } #endif - +/**@}*/ #endif /* end of include file */ |