source: rtems/doc/posix_users/cancel.t @ 8ea8326

4.104.114.84.95
Last change on this file since 8ea8326 was 6449498, checked in by Joel Sherrill <joel.sherrill@…>, on 01/17/02 at 21:47:47

2001-01-17 Joel Sherrill <joel@…>

  • SUPPORT, LICENSE: New files.
  • Numerous files touched as part of merging the 4.5 branch onto the mainline development trunk and ensuring that the script that cuts snapshots and releases works on the documentation.
  • Property mode set to 100644
File size: 3.3 KB
Line 
1@c
2@c COPYRIGHT (c) 1988-2002.
3@c On-Line Applications Research Corporation (OAR).
4@c All rights reserved.
5@c
6@c $Id$
7@c
8
9@chapter Thread Cancellation Manager
10
11@section Introduction
12
13The
14thread cancellation manager is ...
15
16The directives provided by the thread cancellation manager are:
17
18@itemize @bullet
19@item @code{pthread_cancel} - Cancel Execution of a Thread
20@item @code{pthread_setcancelstate} - Set Cancelability State
21@item @code{pthread_setcanceltype} - Set Cancelability Type
22@item @code{pthread_testcancel} - Create Cancellation Point
23@item @code{pthread_cleanup_push} - Establish Cancellation Handler
24@item @code{pthread_cleanup_pop} - Remove Cancellation Handler
25@end itemize
26
27@section Background
28
29There is currently no text in this section.
30
31@section Operations
32
33There is currently no text in this section.
34
35@section Directives
36
37This section details the thread cancellation manager's directives.
38A subsection is dedicated to each of this manager's directives
39and describes the calling sequence, related constants, usage,
40and status codes.
41
42@c
43@c
44@c
45@page
46@subsection pthread_cancel - Cancel Execution of a Thread
47
48@findex pthread_cancel
49@cindex  cancel execution of a thread
50
51@subheading CALLING SEQUENCE:
52
53@ifset is-C
54@example
55int pthread_cancel(
56);
57@end example
58@end ifset
59
60@ifset is-Ada
61@end ifset
62
63@subheading STATUS CODES:
64
65@table @b
66@item E
67The
68
69@end table
70
71@subheading DESCRIPTION:
72
73@subheading NOTES:
74
75@c
76@c
77@c
78@page
79@subsection pthread_setcancelstate - Set Cancelability State
80
81@findex pthread_setcancelstate
82@cindex  set cancelability state
83
84@subheading CALLING SEQUENCE:
85
86@ifset is-C
87@example
88int pthread_setcancelstate(
89);
90@end example
91@end ifset
92
93@ifset is-Ada
94@end ifset
95
96@subheading STATUS CODES:
97
98@table @b
99@item E
100The
101
102@end table
103
104@subheading DESCRIPTION:
105
106@subheading NOTES:
107
108@c
109@c
110@c
111@page
112@subsection pthread_setcanceltype - Set Cancelability Type
113
114@findex pthread_setcanceltype
115@cindex  set cancelability type
116
117@subheading CALLING SEQUENCE:
118
119@ifset is-C
120@example
121int pthread_setcanceltype(
122);
123@end example
124@end ifset
125
126@ifset is-Ada
127@end ifset
128
129@subheading STATUS CODES:
130
131@table @b
132@item E
133The
134
135@end table
136
137@subheading DESCRIPTION:
138
139@subheading NOTES:
140
141@c
142@c
143@c
144@page
145@subsection pthread_testcancel - Create Cancellation Point
146
147@findex pthread_testcancel
148@cindex  create cancellation point
149
150@subheading CALLING SEQUENCE:
151
152@ifset is-C
153@example
154int pthread_testcancel(
155);
156@end example
157@end ifset
158
159@ifset is-Ada
160@end ifset
161
162@subheading STATUS CODES:
163
164@table @b
165@item E
166The
167
168@end table
169
170@subheading DESCRIPTION:
171
172@subheading NOTES:
173
174@c
175@c
176@c
177@page
178@subsection pthread_cleanup_push - Establish Cancellation Handler
179
180@findex pthread_cleanup_push
181@cindex  establish cancellation handler
182
183@subheading CALLING SEQUENCE:
184
185@ifset is-C
186@example
187int pthread_cleanup_push(
188);
189@end example
190@end ifset
191
192@ifset is-Ada
193@end ifset
194
195@subheading STATUS CODES:
196
197@table @b
198@item E
199The
200
201@end table
202
203@subheading DESCRIPTION:
204
205@subheading NOTES:
206
207@c
208@c
209@c
210@page
211@subsection pthread_cleanup_pop - Remove Cancellation Handler
212
213@findex pthread_cleanup_pop
214@cindex  remove cancellation handler
215
216@subheading CALLING SEQUENCE:
217
218@ifset is-C
219@example
220int pthread_cleanup_push(
221);
222@end example
223@end ifset
224
225@ifset is-Ada
226@end ifset
227
228@subheading STATUS CODES:
229
230@table @b
231@item E
232The
233
234@end table
235
236@subheading DESCRIPTION:
237
238@subheading NOTES:
239
Note: See TracBrowser for help on using the repository browser.