Changeset aff08f5 in rtems


Ignore:
Timestamp:
Nov 10, 1999, 1:21:33 PM (20 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
a5f5acad
Parents:
bab5ba44
Message:

Better formatting.

File:
1 edited

Legend:

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

    rbab5ba44 raff08f5  
    1 @c
     1@c@*
    22@c  This is the chapter from the RTEMS ITRON User's Guide that
    33@c  documents the services provided by the mailbox
     
    6464@subheading STATUS CODES:
    6565
    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
     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@*
    7272@code{E_PAR} - Parameter error
    7373
    7474
    75 @subheading DESCRIPTION: Allocated a control area/buffer space for mailbox with some ID.
     75@subheading DESCRIPTION:
     76
     77Allocated a control area/buffer space for mailbox with some ID.
    7678                User area:      +ve ids
    7779                System area:    -ve ids
     
    8284@subheading NOTES:
    8385
     86NONE
     87
    8488
    8589@c
     
    106110@subheading STATUS CODES:
    107111
    108 @code{E_OK} - Normal completion
    109 @code{E_ID} - Invalid ID number
    110 @code{E_NOEXS} - Object does not exist
     112@code{E_OK} - Normal completion@*
     113@code{E_ID} - Invalid ID number@*
     114@code{E_NOEXS} - Object does not exist@*
    111115@code{E_OACV} - Object access violation
    112116
    113 @subheading DESCRIPTION: Specified by the ID, cleans up all data structures and control blocks.
    114 
    115 @subheading NOTES:
     117@subheading DESCRIPTION:
     118
     119Specified by the ID, cleans up all data structures and control blocks.
     120
     121@subheading NOTES:
     122
     123NONE
    116124
    117125
     
    140148@subheading STATUS CODES:
    141149
    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
     150@code{E_OK} - Normal completion@*
     151@code{E_ID} - Invalid ID number@*
     152@code{E_NOEXS} - Object does not exist@*
     153@code{E_OACV} - Object access violation@*
    146154@code{E_QOVR} - Queueing or nesting overflow
    147155
    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.
    149 
    150 @subheading NOTES:
     156@subheading DESCRIPTION:
     157
     158Sends the address of message to mbox having a given id, any waiting tasks (blocked tasks) will be woken up. It supports non-blocking send.
     159
     160@subheading NOTES:
     161
     162NONE
    151163
    152164
     
    175187@subheading STATUS CODES:
    176188
    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
     189@code{E_OK} - Normal completion@*
     190@code{E_ID} - Invalid ID number@*
     191@code{E_NOEXS} - Object does not exist@*
     192@code{E_OACV} - Object access violation@*
     193@code{E_PAR} - Parameter error@*
     194@code{E_DLT} - The object being waited for was deleted@*
     195@code{E_RLWAI} - WAIT state was forcibly released@*
    184196@code{E_CTX} - Context error
    185197
    186 @subheading DESCRIPTION: If there is no message then receiver blocks, if not empty then it takes the first message of the queue.
    187 
    188 @subheading NOTES:
     198@subheading DESCRIPTION:
     199
     200If there is no message then receiver blocks, if not empty then it takes the first message of the queue.
     201
     202@subheading NOTES:
     203
     204NONE
    189205
    190206
     
    213229@subheading STATUS CODES:
    214230
    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.
    225 
    226 @subheading NOTES:
     231@code{E_OK} - Normal completion@*
     232@code{E_ID} - Invalid ID number@*
     233@code{E_NOEXS} - Object does not exist@*
     234@code{E_OACV} - Object access violation@*
     235@code{E_PAR} - Parameter error@*
     236@code{E_DLT} - The object being waited for was deleted@*
     237@code{E_RLWAI} - WAIT state was forcibly released@*
     238@code{E_CTX} - Context error@*
     239
     240@subheading DESCRIPTION:
     241
     242Poll and receive message from mailbox.
     243
     244@subheading NOTES:
     245
     246NONE
    227247
    228248
     
    252272@subheading STATUS CODES:
    253273
    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
     274@code{E_OK} - Normal completion@*
     275@code{E_ID} - Invalid ID number@*
     276@code{E_NOEXS} - Object does not exist@*
     277@code{E_OACV} - Object access violation@*
     278@code{E_PAR} - Parameter error@*
     279@code{E_DLT} - The object being waited for was deleted@*
     280@code{E_RLWAI} - WAIT state was forcibly released@*
    261281@code{E_CTX} - Context error
    262282
    263 @subheading DESCRIPTION: Blocking receive with a maximum timeout.
    264 
    265 @subheading NOTES:
     283@subheading DESCRIPTION:
     284
     285Blocking receive with a maximum timeout.
     286
     287@subheading NOTES:
     288
     289NONE
    266290
    267291
     
    290314@subheading STATUS CODES:
    291315
    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
     316@code{E_OK} - Normal completion@*
     317@code{E_ID} - Invalid ID number@*
     318@code{E_NOEXS} - Object does not exist@*
     319@code{E_OACV} - Object access violation@*
    296320@code{E_PAR} - Parameter error
    297321
    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 
     322@subheading DESCRIPTION:
     323
     324Supports non-blocking receive. If there are no messages, it returns -1. Also returns id of the next process waiting on a message.
     325
     326@subheading NOTES:
     327
     328NONE
     329
     330
Note: See TracChangeset for help on using the changeset viewer.