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