source: rtems/doc/posix_users/cancel.t @ a518cc11

4.104.114.84.95
Last change on this file since a518cc11 was a518cc11, checked in by Joel Sherrill <joel.sherrill@…>, on 10/11/99 at 20:24:37

Added descriptions.

  • Property mode set to 100644
File size: 2.8 KB
Line 
1@c
2@c  COPYRIGHT (c) 1988-1998.
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@page
43@subsection pthread_cancel - Cancel Execution of a Thread
44
45@subheading CALLING SEQUENCE:
46
47@ifset is-C
48@example
49int pthread_cancel(
50);
51@end example
52@end ifset
53
54@ifset is-Ada
55@end ifset
56
57@subheading STATUS CODES:
58
59@table @b
60@item E
61The
62
63@end table
64
65@subheading DESCRIPTION:
66
67@subheading NOTES:
68
69@page
70@subsection pthread_setcancelstate - Set Cancelability State
71
72@subheading CALLING SEQUENCE:
73
74@ifset is-C
75@example
76int pthread_setcancelstate(
77);
78@end example
79@end ifset
80
81@ifset is-Ada
82@end ifset
83
84@subheading STATUS CODES:
85
86@table @b
87@item E
88The
89
90@end table
91
92@subheading DESCRIPTION:
93
94@subheading NOTES:
95
96@page
97@subsection pthread_setcanceltype - Set Cancelability Type
98
99@subheading CALLING SEQUENCE:
100
101@ifset is-C
102@example
103int pthread_setcanceltype(
104);
105@end example
106@end ifset
107
108@ifset is-Ada
109@end ifset
110
111@subheading STATUS CODES:
112
113@table @b
114@item E
115The
116
117@end table
118
119@subheading DESCRIPTION:
120
121@subheading NOTES:
122
123@page
124@subsection pthread_testcancel - Create Cancellation Point
125
126@subheading CALLING SEQUENCE:
127
128@ifset is-C
129@example
130int pthread_testcancel(
131);
132@end example
133@end ifset
134
135@ifset is-Ada
136@end ifset
137
138@subheading STATUS CODES:
139
140@table @b
141@item E
142The
143
144@end table
145
146@subheading DESCRIPTION:
147
148@subheading NOTES:
149
150@page
151@subsection pthread_cleanup_push - Establish Cancellation Handler
152
153@subheading CALLING SEQUENCE:
154
155@ifset is-C
156@example
157int pthread_cleanup_push(
158);
159@end example
160@end ifset
161
162@ifset is-Ada
163@end ifset
164
165@subheading STATUS CODES:
166
167@table @b
168@item E
169The
170
171@end table
172
173@subheading DESCRIPTION:
174
175@subheading NOTES:
176
177@page
178@subsection pthread_cleanup_pop - Remove Cancellation Handler
179
180@subheading CALLING SEQUENCE:
181
182@ifset is-C
183@example
184int pthread_cleanup_push(
185);
186@end example
187@end ifset
188
189@ifset is-Ada
190@end ifset
191
192@subheading STATUS CODES:
193
194@table @b
195@item E
196The
197
198@end table
199
200@subheading DESCRIPTION:
201
202@subheading NOTES:
203
Note: See TracBrowser for help on using the repository browser.