source: rtems/doc/itron3.0/rendezvous.t @ 086a898a

4.104.114.84.95
Last change on this file since 086a898a was 086a898a, checked in by Joel Sherrill <joel.sherrill@…>, on Nov 16, 1999 at 7:47:37 PM

Added copyright.

  • Property mode set to 100644
File size: 4.9 KB
Line 
1@c
2@c  COPYRIGHT (c) 1988-1999.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5@c
6@c  This is the chapter from the RTEMS ITRON User's Guide that
7@c  documents the services provided by the rendezvous
8@c  manager.
9@c
10@c  $Id$
11@c
12
13@chapter Rendezvous Manager
14
15@section Introduction
16
17The
18rendezvous manager is ...
19
20The services provided by the rendezvous manager are:
21
22@itemize @bullet
23@item @code{cre_por} - Create Port for Rendezvous
24@item @code{del_por} - Delete Port for Rendezvous
25@item @code{cal_por} - Call Port for Rendezvous
26@item @code{pcal_por} - Poll and Call Port for Rendezvous
27@item @code{tcal_por} - Call Port for Rendezvous with Timeout
28@item @code{acp_por} - Accept Port for Rendezvous
29@item @code{pacp_por} - Poll and Accept Port for Rendezvous
30@item @code{tacp_por} - Accept Port for Rendezvous with Timeout
31@item @code{fwd_por} - Forward Rendezvous to Other Port
32@item @code{rpl_rdv} - Reply Rendezvous
33@item @code{ref_por} - Reference Port Status
34@end itemize
35
36@section Background
37
38@section Operations
39
40@section System Calls
41
42This section details the rendezvous manager's services.
43A subsection is dedicated to each of this manager's services
44and describes the calling sequence, related constants, usage,
45and status codes.
46
47
48@c
49@c  cre_por
50@c
51
52@page
53@subsection cre_por - Create Port for Rendezvous
54
55@subheading CALLING SEQUENCE:
56
57@ifset is-C
58@example
59ER cre_por(
60  ID porid,
61  T_CPOR *pk_cpor
62);
63@end example
64@end ifset
65
66@ifset is-Ada
67@end ifset
68
69@subheading STATUS CODES:
70
71@code{EXXX} -
72
73@subheading DESCRIPTION:
74
75@subheading NOTES:
76
77
78@c
79@c  del_por
80@c
81
82@page
83@subsection del_por - Delete Port for Rendezvous
84
85@subheading CALLING SEQUENCE:
86
87@ifset is-C
88@example
89ER del_por(
90  ID porid
91);
92@end example
93@end ifset
94
95@ifset is-Ada
96@end ifset
97
98@subheading STATUS CODES:
99
100@code{EXXX} -
101
102@subheading DESCRIPTION:
103
104@subheading NOTES:
105
106
107@c
108@c  cal_por
109@c
110
111@page
112@subsection cal_por - Call Port for Rendezvous Poll
113
114@subheading CALLING SEQUENCE:
115
116@ifset is-C
117@example
118ER cal_por(
119  VP msg,
120  INT *p_rmsgsz,
121  ID porid,
122  UINT calptn
123);
124@end example
125@end ifset
126
127@ifset is-Ada
128@end ifset
129
130@subheading STATUS CODES:
131
132@code{EXXX} -
133
134@subheading DESCRIPTION:
135
136@subheading NOTES:
137
138
139@c
140@c  pcal_por
141@c
142
143@page
144@subsection pcal_por - Poll and Call Port for Rendezvous
145
146@subheading CALLING SEQUENCE:
147
148@ifset is-C
149@example
150ER ercd =pcal_por(
151  VP msg,
152  INT *p_rmsgsz,
153  ID porid,
154  UINT calptn,
155  INT
156);
157@end example
158@end ifset
159
160@ifset is-Ada
161@end ifset
162
163@subheading STATUS CODES:
164
165@code{EXXX} -
166
167@subheading DESCRIPTION:
168
169@subheading NOTES:
170
171
172@c
173@c  tcal_por
174@c
175
176@page
177@subsection tcal_por - Call Port for Rendezvous with Timeout
178
179@subheading CALLING SEQUENCE:
180
181@ifset is-C
182@example
183ER ercd =tcal_por(
184  VP msg,
185  INT *p_rmsgsz,
186  ID porid,
187  UINT calptn,
188  INT
189);
190@end example
191@end ifset
192
193@ifset is-Ada
194@end ifset
195
196@subheading STATUS CODES:
197
198@code{EXXX} -
199
200@subheading DESCRIPTION:
201
202@subheading NOTES:
203
204
205@c
206@c  acp_por
207@c
208
209@page
210@subsection acp_por - Accept Port for Rendezvous Poll
211
212@subheading CALLING SEQUENCE:
213
214@ifset is-C
215@example
216ER acp_por(
217  RNO *p_rdvno,
218  VP msg,
219  INT *p_cmsgsz,
220  ID porid
221);
222@end example
223@end ifset
224
225@ifset is-Ada
226@end ifset
227
228@subheading STATUS CODES:
229
230@code{EXXX} -
231
232@subheading DESCRIPTION:
233
234@subheading NOTES:
235
236
237@c
238@c  pacp_por
239@c
240
241@page
242@subsection pacp_por - Poll and Accept Port for Rendezvous
243
244@subheading CALLING SEQUENCE:
245
246@ifset is-C
247@example
248ER ercd =pacp_por(
249  RNO *p_rdvno,
250  VP msg,
251  INT *p_cmsgsz,
252  ID porid,
253  UINT
254);
255@end example
256@end ifset
257
258@ifset is-Ada
259@end ifset
260
261@subheading STATUS CODES:
262
263@code{EXXX} -
264
265@subheading DESCRIPTION:
266
267@subheading NOTES:
268
269
270@c
271@c  tacp_por
272@c
273
274@page
275@subsection tacp_por - Accept Port for Rendezvous with Timeout
276
277@subheading CALLING SEQUENCE:
278
279@ifset is-C
280@example
281ER ercd =tacp_por(
282  RNO *p_rdvno,
283  VP msg,
284  INT *p_cmsgsz,
285  ID porid,
286  UINT
287);
288@end example
289@end ifset
290
291@ifset is-Ada
292@end ifset
293
294@subheading STATUS CODES:
295
296@code{EXXX} -
297
298@subheading DESCRIPTION:
299
300@subheading NOTES:
301
302
303@c
304@c  fwd_por
305@c
306
307@page
308@subsection fwd_por - Forward Rendezvous to Other Port
309
310@subheading CALLING SEQUENCE:
311
312@ifset is-C
313@example
314ER fwd_por(
315  ID porid,
316  UINT calptn,
317  RNO rdvno,
318  VP msg,
319  INT cmsgsz
320);
321@end example
322@end ifset
323
324@ifset is-Ada
325@end ifset
326
327@subheading STATUS CODES:
328
329@code{EXXX} -
330
331@subheading DESCRIPTION:
332
333@subheading NOTES:
334
335
336@c
337@c  rpl_rdv
338@c
339
340@page
341@subsection rpl_rdv - Reply Rendezvous
342
343@subheading CALLING SEQUENCE:
344
345@ifset is-C
346@example
347ER rpl_rdv(
348  RNO rdvno,
349  VP msg,
350  INT rmsgsz
351);
352@end example
353@end ifset
354
355@ifset is-Ada
356@end ifset
357
358@subheading STATUS CODES:
359
360@code{EXXX} -
361
362@subheading DESCRIPTION:
363
364@subheading NOTES:
365
366
367@c
368@c  ref_por
369@c
370
371@page
372@subsection ref_por - Reference Port Status
373
374@subheading CALLING SEQUENCE:
375
376@ifset is-C
377@example
378ER ref_por(
379  T_RPOR *pk_rpor,
380  ID porid
381);
382@end example
383@end ifset
384
385@ifset is-Ada
386@end ifset
387
388@subheading STATUS CODES:
389
390@code{EXXX} -
391
392@subheading DESCRIPTION:
393
394@subheading NOTES:
395
Note: See TracBrowser for help on using the repository browser.