source: rtems/doc/itron3.0/mailbox.t @ 110bdfe

4.104.114.84.95
Last change on this file since 110bdfe was 110bdfe, checked in by Joel Sherrill <joel.sherrill@…>, on 05/26/99 at 18:20:40

Made the gen_section more accurate.

  • Property mode set to 100644
File size: 3.1 KB
Line 
1@c
2@c  This is the chapter from the RTEMS ITRON User's Guide that
3@c  documents the services provided by the mailbox
4@c  manager.
5@c
6@c  $Id$
7@c
8
9@chapter Mailbox Manager
10
11@section Introduction
12
13The
14mailbox manager is ...
15
16The services provided by the mailbox manager are:
17
18@itemize @bullet
19@item @code{cre_mbx} - Create Mailbox
20@item @code{del_mbx} - Delete Mailbox
21@item @code{snd_msg} - Send Message to Mailbox
22@item @code{rcv_msg} - Receive Message from Mailbox
23@item @code{prcv_msg} - Poll and Receive Message from Mailbox
24@item @code{trcv_msg} - Receive Message from Mailbox with Timeout
25@item @code{ref_mbx} - Reference Mailbox Status
26@end itemize
27
28@section Background
29
30@section Operations
31
32@section System Calls
33
34This section details the mailbox manager's services.
35A subsection is dedicated to each of this manager's services
36and describes the calling sequence, related constants, usage,
37and status codes.
38
39
40@c
41@c  cre_mbx
42@c
43
44@page
45@subsection cre_mbx -  Create Mailbox
46
47@subheading CALLING SEQUENCE:
48
49@ifset is-C
50@example
51ER cre_mbx (
52 ID mbxid, T_CMBX* pk_cmbx
53);
54@end example
55@end ifset
56
57@ifset is-Ada
58@end ifset
59
60@subheading STATUS CODES:
61
62@code{EXXX} -
63
64@subheading DESCRIPTION:
65
66@subheading NOTES:
67
68
69@c
70@c  del_mbx
71@c
72
73@page
74@subsection del_mbx -  Delete Mailbox
75
76@subheading CALLING SEQUENCE:
77
78@ifset is-C
79@example
80ER del_mbx (
81 ID mbxid
82);
83@end example
84@end ifset
85
86@ifset is-Ada
87@end ifset
88
89@subheading STATUS CODES:
90
91@code{EXXX} -
92
93@subheading DESCRIPTION:
94
95@subheading NOTES:
96
97
98@c
99@c  snd_msg
100@c
101
102@page
103@subsection snd_msg -  Send Message to Mailbox
104
105@subheading CALLING SEQUENCE:
106
107@ifset is-C
108@example
109ER snd_msg (
110 ID mbxid, T_MSG *pk_msg
111);
112@end example
113@end ifset
114
115@ifset is-Ada
116@end ifset
117
118@subheading STATUS CODES:
119
120@code{EXXX} -
121
122@subheading DESCRIPTION:
123
124@subheading NOTES:
125
126
127@c
128@c  rcv_msg
129@c
130
131@page
132@subsection rcv_msg -  Poll and Receive Message from Mailbox Receive Message from Mailbox Receive Message from Mailbox with Timeout
133
134@subheading CALLING SEQUENCE:
135
136@ifset is-C
137@example
138ER rcv_msg (
139 T_MSG **ppk_msg, ID mbxid ER ercd =prcv_msg
140);
141@end example
142@end ifset
143
144@ifset is-Ada
145@end ifset
146
147@subheading STATUS CODES:
148
149@code{EXXX} -
150
151@subheading DESCRIPTION:
152
153@subheading NOTES:
154
155
156@c
157@c  prcv_msg
158@c
159
160@page
161@subsection prcv_msg -  Poll and Receive Message from Mailbox
162
163@subheading CALLING SEQUENCE:
164
165@ifset is-C
166@example
167ER ercd =prcv_msg (
168 T_MSG **ppk_msg, ID mbxid
169);
170@end example
171@end ifset
172
173@ifset is-Ada
174@end ifset
175
176@subheading STATUS CODES:
177
178@code{EXXX} -
179
180@subheading DESCRIPTION:
181
182@subheading NOTES:
183
184
185@c
186@c  trcv_msg
187@c
188
189@page
190@subsection trcv_msg -  Receive Message from Mailbox with Timeout
191
192@subheading CALLING SEQUENCE:
193
194@ifset is-C
195@example
196ER ercd =trcv_msg (
197 T_MSG **ppk_msg, ID mbxid, TMO tmout
198);
199@end example
200@end ifset
201
202@ifset is-Ada
203@end ifset
204
205@subheading STATUS CODES:
206
207@code{EXXX} -
208
209@subheading DESCRIPTION:
210
211@subheading NOTES:
212
213
214@c
215@c  ref_mbx
216@c
217
218@page
219@subsection ref_mbx -  Reference Mailbox Status
220
221@subheading CALLING SEQUENCE:
222
223@ifset is-C
224@example
225ER ref_mbx (
226 T_RMBX *pk_rmbx, ID mbxid
227);
228@end example
229@end ifset
230
231@ifset is-Ada
232@end ifset
233
234@subheading STATUS CODES:
235
236@code{EXXX} -
237
238@subheading DESCRIPTION:
239
240@subheading NOTES:
241
Note: See TracBrowser for help on using the repository browser.