source: rtems/doc/posix_users/key.texi @ ae68ff0

4.104.114.84.95
Last change on this file since ae68ff0 was ae68ff0, checked in by Joel Sherrill <joel.sherrill@…>, on 05/27/97 at 12:40:11

Initial revision

  • Property mode set to 100644
File size: 3.2 KB
Line 
1@c
2@c  COPYRIGHT (c) 1996.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5@c
6
7@ifinfo
8@node Key Manager, Key Manager Introduction, pthread_cond_timedwait, Top
9@end ifinfo
10@chapter Key Manager
11@ifinfo
12@menu
13* Key Manager Introduction::
14* Key Manager Background::
15* Key Manager Operations::
16* Key Manager Directives::
17@end menu
18@end ifinfo
19
20@ifinfo
21@node Key Manager Introduction, Key Manager Background, Key Manager, Key Manager
22@end ifinfo
23@section Introduction
24
25The key manager ...
26
27The directives provided by the key manager are:
28
29@itemize @bullet
30@item @code{pthread_key_create} -
31@item @code{pthread_key_delete} -
32@item @code{pthread_setspecific} -
33@item @code{pthread_getspecific} -
34@end itemize
35
36@ifinfo
37@node Key Manager Background, Key Manager Operations, Key Manager Introduction, Key Manager
38@end ifinfo
39@section Background
40
41@ifinfo
42@node Key Manager Operations, Key Manager Directives, Key Manager Background, Key Manager
43@end ifinfo
44@section Operations
45
46@ifinfo
47@node Key Manager Directives, pthread_key_create, Key Manager Operations, Key Manager
48@end ifinfo
49@section Directives
50@ifinfo
51@menu
52* pthread_key_create::
53* pthread_key_delete::
54* pthread_setspecific::
55* pthread_getspecific::
56@end menu
57@end ifinfo
58
59This section details the key manager's directives.
60A subsection is dedicated to each of this manager's directives
61and describes the calling sequence, related constants, usage,
62and status codes.
63
64@page
65@ifinfo
66@node pthread_key_create, pthread_key_delete, Key Manager Directives, Key Manager Directives
67@end ifinfo
68@subsection pthread_key_create
69
70@subheading CALLING SEQUENCE:
71
72@example
73#include <pthread.h>
74
75int pthread_key_create(
76  pthread_key_t  *key,
77  void          (*destructor)( void * )
78);
79@end example
80
81@subheading STATUS CODES:
82
83@table @b
84@item EAGAIN
85There were not enough resources available to create another key.
86
87@item ENOMEM
88Insufficient memory exists to create the key.
89
90@end table
91
92@page
93@ifinfo
94@node pthread_key_delete, pthread_setspecific, pthread_key_create, Key Manager Directives
95@end ifinfo
96@subsection pthread_key_delete
97 
98@subheading CALLING SEQUENCE:
99 
100@example
101#include <pthread.h>
102 
103int pthread_key_delete(
104  pthread_key_t  key,
105);
106@end example
107 
108@subheading STATUS CODES:
109 
110@table @b
111@item EINVAL
112The key was invalid
113 
114@end table
115
116@subheading DESCRIPTION:
117
118@subheading NOTES:
119
120@page
121@ifinfo
122@node pthread_setspecific, pthread_getspecific, pthread_key_delete, Key Manager Directives
123@end ifinfo
124@subsection pthread_setspecific
125
126@subheading CALLING SEQUENCE:
127
128@example
129#include <pthread.h>
130
131int pthread_setspecific(
132  pthread_key_t  key,
133  const void    *value
134);
135@end example
136
137@subheading STATUS CODES:
138@table @b
139@item EINVAL
140The specified key is invalid.
141
142@end table
143
144@subheading DESCRIPTION:
145
146@subheading NOTES:
147
148@page
149@ifinfo
150@node pthread_getspecific, Clock Manager, pthread_setspecific, Key Manager Directives
151@end ifinfo
152@subsection pthread_getspecific
153
154@subheading CALLING SEQUENCE:
155
156@example
157#include <pthread.h>
158
159void *pthread_getspecific(
160  pthread_key_t  key
161);
162@end example
163
164@subheading STATUS CODES:
165@table @b
166@item NULL
167There is no thread-specific data associated with the specified key.
168
169@item non-NULL
170The data associated with the specified key.
171
172@end table
173
174@subheading DESCRIPTION:
175
176@subheading NOTES:
177
Note: See TracBrowser for help on using the repository browser.