Changeset a3c8bda in rtems

Timestamp:

08/02/99 13:55:39 (24 years ago)

Author:

Joel Sherrill <joel.sherrill@…>

Branches:

4.10, 4.11, 4.8, 4.9, 5, master

Children:

bd527866

Parents:

1896a650

Message:

Update from Andrew McDowell? <drew@…>. DOS CR/LF, etc fixed
by Joel.

File:

• doc/itron3.0/mailbox.t (modified) (18 diffs)

doc/itron3.0/mailbox.t

@@ -7 +7 @@
 @c
 
+
 @chapter Mailbox Manager
 
 @section Introduction
 
-The 
-mailbox manager is ...
+The
+mailbox manager is basically a linked list, hidden by the super core message queue and consists of a control block, a private structure. The control block comprises of the create mailbox structure, the message structure and the reference mailbox structure.
 
 The services provided by the mailbox manager are:
@@ -26 +27 @@
 @end itemize
 
+
 @section Background
 
@@ -43 +45 @@
 
 @page
+
 @subsection cre_mbx - Create Mailbox
 
@@ -61 +64 @@
 @subheading STATUS CODES:
 
-@code{EXXX} - 
-
-@subheading DESCRIPTION:
+@code{E_OK} - Normal completion
+@code{E_NOMEM} - Insufficient memory
+@code{E_ID} - Invalid ID number
+@code{E_RSATR} - Reserved attribute
+@code{E_OBJ} - Invalid object state
+@code{E_OACV} - Object access violation
+@code{E_PAR} - Parameter error
+
+
+@subheading DESCRIPTION: Allocated a control area/buffer space for mailbox with some ID.
+                User area:      +ve ids
+                System area:    -ve ids
+User may specify if its FIFO or priority level queue.
+Assumes shared memory b/w communicating processes.
+Initializes core message queue for this mbox.
 
 @subheading NOTES:
@@ -73 +88 @@
 
 @page
+
 @subsection del_mbx - Delete Mailbox
 
@@ -90 +106 @@
 @subheading STATUS CODES:
 
-@code{EXXX} - 
-
-@subheading DESCRIPTION:
+@code{E_OK} - Normal completion
+@code{E_ID} - Invalid ID number
+@code{E_NOEXS} - Object does not exist
+@code{E_OACV} - Object access violation
+
+@subheading DESCRIPTION: Specified by the ID, cleans up all data structures and control blocks.
 
 @subheading NOTES:
@@ -102 +121 @@
 
 @page
+
 @subsection snd_msg - Send Message to Mailbox
 
@@ -120 +140 @@
 @subheading STATUS CODES:
 
-@code{EXXX} - 
-
-@subheading DESCRIPTION:
+@code{E_OK} - Normal completion
+@code{E_ID} - Invalid ID number
+@code{E_NOEXS} - Object does not exist
+@code{E_OACV} - Object access violation
+@code{E_QOVR} - Queueing or nesting overflow
+
+@subheading DESCRIPTION: Sends the address of message to mbox having a given id, any waiting tasks (blocked tasks) will be woken up. It supports non-blocking send.
 
 @subheading NOTES:
@@ -132 +156 @@
 
 @page
-@subsection rcv_msg - Receive Message from Mailbox 
+
+@subsection rcv_msg - Receive Message from Mailbox
 
 @subheading CALLING SEQUENCE:
@@ -150 +175 @@
 @subheading STATUS CODES:
 
-@code{EXXX} - 
-
-@subheading DESCRIPTION:
+@code{E_OK} - Normal completion
+@code{E_ID} - Invalid ID number
+@code{E_NOEXS} - Object does not exist
+@code{E_OACV} - Object access violation
+@code{E_PAR} - Parameter error
+@code{E_DLT} - The object being waited for was deleted
+@code{E_RLWAI} - WAIT state was forcibly released
+@code{E_CTX} - Context error
+
+@subheading DESCRIPTION: If there is no message then receiver blocks, if not empty then it takes the first message of the queue.
 
 @subheading NOTES:
@@ -162 +194 @@
 
 @page
+
 @subsection prcv_msg - Poll and Receive Message from Mailbox
 
@@ -168 +201 @@
 @ifset is-C
 @example
-ER ercd =prcv_msg(
+ER prcv_msg(
   T_MSG **ppk_msg,
   ID mbxid
@@ -180 +213 @@
 @subheading STATUS CODES:
 
-@code{EXXX} - 
-
-@subheading DESCRIPTION:
+@code{E_OK} - Normal completion
+@code{E_ID} - Invalid ID number
+@code{E_NOEXS} - Object does not exist
+@code{E_OACV} - Object access violation
+@code{E_PAR} - Parameter error
+@code{E_DLT} - The object being waited for was deleted
+@code{E_RLWAI} - WAIT state was forcibly released
+@code{E_CTX} - Context error
+
+@subheading DESCRIPTION: Poll and receive message from mailbox.
 
 @subheading NOTES:
@@ -192 +232 @@
 
 @page
+
 @subsection trcv_msg - Receive Message from Mailbox with Timeout
 
@@ -198 +239 @@
 @ifset is-C
 @example
-ER ercd =trcv_msg(
+ER trcv_msg(
   T_MSG **ppk_msg,
   ID mbxid,
@@ -211 +252 @@
 @subheading STATUS CODES:
 
-@code{EXXX} - 
-
-@subheading DESCRIPTION:
+@code{E_OK} - Normal completion
+@code{E_ID} - Invalid ID number
+@code{E_NOEXS} - Object does not exist
+@code{E_OACV} - Object access violation
+@code{E_PAR} - Parameter error
+@code{E_DLT} - The object being waited for was deleted
+@code{E_RLWAI} - WAIT state was forcibly released
+@code{E_CTX} - Context error
+
+@subheading DESCRIPTION: Blocking receive with a maximum timeout.
 
 @subheading NOTES:
@@ -223 +271 @@
 
 @page
+
 @subsection ref_mbx - Reference Mailbox Status
 
@@ -241 +290 @@
 @subheading STATUS CODES:
 
-@code{EXXX} - 
-
-@subheading DESCRIPTION:
-
-@subheading NOTES:
-
+@code{E_OK} - Normal completion
+@code{E_ID} - Invalid ID number
+@code{E_NOEXS} - Object does not exist
+@code{E_OACV} - Object access violation
+@code{E_PAR} - Parameter error
+
+@subheading DESCRIPTION: Supports non-blocking receive. If there are no messages, it returns -1. Also returns id of the next process waiting on a message.
+
+@subheading NOTES:
+
+