RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

Better formatting.

Browse Source
This commit is contained in:
Joel Sherrill
1999-11-10 13:21:33 +00:00
parent bab5ba4446
commit aff08f541b
1 changed files with 75 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

122
doc/itron3.0/mailbox.t
View File

@@ -1,4 +1,4 @@
@c
@c@*
@c This is the chapter from the RTEMS ITRON User's Guide that
@c documents the services provided by the mailbox
@c manager.
@@ -63,16 +63,18 @@ ER cre_mbx(
@subheading STATUS CODES:
@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_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.
@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.
@@ -81,6 +83,8 @@ Initializes core message queue for this mbox.
@subheading NOTES:
NONE
@c
@c del_mbx
@@ -105,15 +109,19 @@ ER del_mbx(
@subheading STATUS CODES:
@code{E_OK} - Normal completion
@code{E_ID} - Invalid ID number
@code{E_NOEXS} - Object does not exist
@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 DESCRIPTION:
Specified by the ID, cleans up all data structures and control blocks.
@subheading NOTES:
NONE
@c
@c snd_msg
@@ -139,16 +147,20 @@ ER snd_msg(
@subheading STATUS CODES:
@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_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 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:
NONE
@c
@c rcv_msg
@@ -174,19 +186,23 @@ ER rcv_msg(
@subheading STATUS CODES:
@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_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 DESCRIPTION:
If there is no message then receiver blocks, if not empty then it takes the first message of the queue.
@subheading NOTES:
NONE
@c
@c prcv_msg
@@ -212,19 +228,23 @@ ER prcv_msg(
@subheading STATUS CODES:
@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
@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 DESCRIPTION:
Poll and receive message from mailbox.
@subheading NOTES:
NONE
@c
@c trcv_msg
@@ -251,19 +271,23 @@ ER trcv_msg(
@subheading STATUS CODES:
@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_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 DESCRIPTION:
Blocking receive with a maximum timeout.
@subheading NOTES:
NONE
@c
@c ref_mbx
@@ -289,14 +313,18 @@ ER ref_mbx(
@subheading STATUS CODES:
@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_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 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:
NONE