Changeset a3c8bda in rtems


Ignore:
Timestamp:
Aug 2, 1999, 1:55:39 PM (21 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
bd527866
Parents:
1896a650
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/itron3.0/mailbox.t

    r1896a650 ra3c8bda  
    77@c
    88
     9
    910@chapter Mailbox Manager
    1011
    1112@section Introduction
    1213
    13 The 
    14 mailbox manager is ...
     14The
     15mailbox 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.
    1516
    1617The services provided by the mailbox manager are:
     
    2627@end itemize
    2728
     29
    2830@section Background
    2931
     
    4345
    4446@page
     47
    4548@subsection cre_mbx - Create Mailbox
    4649
     
    6164@subheading STATUS CODES:
    6265
    63 @code{EXXX} -
    64 
    65 @subheading DESCRIPTION:
     66@code{E_OK} - Normal completion
     67@code{E_NOMEM} - Insufficient memory
     68@code{E_ID} - Invalid ID number
     69@code{E_RSATR} - Reserved attribute
     70@code{E_OBJ} - Invalid object state
     71@code{E_OACV} - Object access violation
     72@code{E_PAR} - Parameter error
     73
     74
     75@subheading DESCRIPTION: Allocated a control area/buffer space for mailbox with some ID.
     76                User area:      +ve ids
     77                System area:    -ve ids
     78User may specify if its FIFO or priority level queue.
     79Assumes shared memory b/w communicating processes.
     80Initializes core message queue for this mbox.
    6681
    6782@subheading NOTES:
     
    7388
    7489@page
     90
    7591@subsection del_mbx - Delete Mailbox
    7692
     
    90106@subheading STATUS CODES:
    91107
    92 @code{EXXX} -
    93 
    94 @subheading DESCRIPTION:
     108@code{E_OK} - Normal completion
     109@code{E_ID} - Invalid ID number
     110@code{E_NOEXS} - Object does not exist
     111@code{E_OACV} - Object access violation
     112
     113@subheading DESCRIPTION: Specified by the ID, cleans up all data structures and control blocks.
    95114
    96115@subheading NOTES:
     
    102121
    103122@page
     123
    104124@subsection snd_msg - Send Message to Mailbox
    105125
     
    120140@subheading STATUS CODES:
    121141
    122 @code{EXXX} -
    123 
    124 @subheading DESCRIPTION:
     142@code{E_OK} - Normal completion
     143@code{E_ID} - Invalid ID number
     144@code{E_NOEXS} - Object does not exist
     145@code{E_OACV} - Object access violation
     146@code{E_QOVR} - Queueing or nesting overflow
     147
     148@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.
    125149
    126150@subheading NOTES:
     
    132156
    133157@page
    134 @subsection rcv_msg - Receive Message from Mailbox
     158
     159@subsection rcv_msg - Receive Message from Mailbox
    135160
    136161@subheading CALLING SEQUENCE:
     
    150175@subheading STATUS CODES:
    151176
    152 @code{EXXX} -
    153 
    154 @subheading DESCRIPTION:
     177@code{E_OK} - Normal completion
     178@code{E_ID} - Invalid ID number
     179@code{E_NOEXS} - Object does not exist
     180@code{E_OACV} - Object access violation
     181@code{E_PAR} - Parameter error
     182@code{E_DLT} - The object being waited for was deleted
     183@code{E_RLWAI} - WAIT state was forcibly released
     184@code{E_CTX} - Context error
     185
     186@subheading DESCRIPTION: If there is no message then receiver blocks, if not empty then it takes the first message of the queue.
    155187
    156188@subheading NOTES:
     
    162194
    163195@page
     196
    164197@subsection prcv_msg - Poll and Receive Message from Mailbox
    165198
     
    168201@ifset is-C
    169202@example
    170 ER ercd =prcv_msg(
     203ER prcv_msg(
    171204  T_MSG **ppk_msg,
    172205  ID mbxid
     
    180213@subheading STATUS CODES:
    181214
    182 @code{EXXX} -
    183 
    184 @subheading DESCRIPTION:
     215@code{E_OK} - Normal completion
     216@code{E_ID} - Invalid ID number
     217@code{E_NOEXS} - Object does not exist
     218@code{E_OACV} - Object access violation
     219@code{E_PAR} - Parameter error
     220@code{E_DLT} - The object being waited for was deleted
     221@code{E_RLWAI} - WAIT state was forcibly released
     222@code{E_CTX} - Context error
     223
     224@subheading DESCRIPTION: Poll and receive message from mailbox.
    185225
    186226@subheading NOTES:
     
    192232
    193233@page
     234
    194235@subsection trcv_msg - Receive Message from Mailbox with Timeout
    195236
     
    198239@ifset is-C
    199240@example
    200 ER ercd =trcv_msg(
     241ER trcv_msg(
    201242  T_MSG **ppk_msg,
    202243  ID mbxid,
     
    211252@subheading STATUS CODES:
    212253
    213 @code{EXXX} -
    214 
    215 @subheading DESCRIPTION:
     254@code{E_OK} - Normal completion
     255@code{E_ID} - Invalid ID number
     256@code{E_NOEXS} - Object does not exist
     257@code{E_OACV} - Object access violation
     258@code{E_PAR} - Parameter error
     259@code{E_DLT} - The object being waited for was deleted
     260@code{E_RLWAI} - WAIT state was forcibly released
     261@code{E_CTX} - Context error
     262
     263@subheading DESCRIPTION: Blocking receive with a maximum timeout.
    216264
    217265@subheading NOTES:
     
    223271
    224272@page
     273
    225274@subsection ref_mbx - Reference Mailbox Status
    226275
     
    241290@subheading STATUS CODES:
    242291
    243 @code{EXXX} -
    244 
    245 @subheading DESCRIPTION:
    246 
    247 @subheading NOTES:
    248 
     292@code{E_OK} - Normal completion
     293@code{E_ID} - Invalid ID number
     294@code{E_NOEXS} - Object does not exist
     295@code{E_OACV} - Object access violation
     296@code{E_PAR} - Parameter error
     297
     298@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.
     299
     300@subheading NOTES:
     301
     302
Note: See TracChangeset for help on using the changeset viewer.