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 $Id$ |
---|
7 | @c |
---|
8 | |
---|
9 | @chapter Key Manager |
---|
10 | |
---|
11 | @section Introduction |
---|
12 | |
---|
13 | The key manager ... |
---|
14 | |
---|
15 | The directives provided by the key manager are: |
---|
16 | |
---|
17 | @itemize @bullet |
---|
18 | @item @code{pthread_key_create} - Create Thread Specific Data Key |
---|
19 | @item @code{pthread_key_delete} - Delete Thread Specific Data Key |
---|
20 | @item @code{pthread_setspecific} - Set Thread Specific Key Value |
---|
21 | @item @code{pthread_getspecific} - Get Thread Specific Key Value |
---|
22 | @end itemize |
---|
23 | |
---|
24 | @section Background |
---|
25 | |
---|
26 | There is currently no text in this section. |
---|
27 | |
---|
28 | @section Operations |
---|
29 | |
---|
30 | There is currently no text in this section. |
---|
31 | |
---|
32 | @section Directives |
---|
33 | |
---|
34 | This section details the key manager's directives. |
---|
35 | A subsection is dedicated to each of this manager's directives |
---|
36 | and describes the calling sequence, related constants, usage, |
---|
37 | and status codes. |
---|
38 | |
---|
39 | @c |
---|
40 | @c |
---|
41 | @c |
---|
42 | @page |
---|
43 | @subsection pthread_key_create - Create Thread Specific Data Key |
---|
44 | |
---|
45 | @subheading CALLING SEQUENCE: |
---|
46 | |
---|
47 | @example |
---|
48 | #include <pthread.h> |
---|
49 | |
---|
50 | int pthread_key_create( |
---|
51 | pthread_key_t *key, |
---|
52 | void (*destructor)( void ) |
---|
53 | ); |
---|
54 | @end example |
---|
55 | |
---|
56 | @subheading STATUS CODES: |
---|
57 | |
---|
58 | @table @b |
---|
59 | @item EAGAIN |
---|
60 | There were not enough resources available to create another key. |
---|
61 | |
---|
62 | @item ENOMEM |
---|
63 | Insufficient memory exists to create the key. |
---|
64 | |
---|
65 | @end table |
---|
66 | |
---|
67 | @c |
---|
68 | @c |
---|
69 | @c |
---|
70 | @page |
---|
71 | @subsection pthread_key_delete - Delete Thread Specific Data Key |
---|
72 | |
---|
73 | @subheading CALLING SEQUENCE: |
---|
74 | |
---|
75 | @example |
---|
76 | #include <pthread.h> |
---|
77 | |
---|
78 | int pthread_key_delete( |
---|
79 | pthread_key_t key, |
---|
80 | ); |
---|
81 | @end example |
---|
82 | |
---|
83 | @subheading STATUS CODES: |
---|
84 | |
---|
85 | @table @b |
---|
86 | @item EINVAL |
---|
87 | The key was invalid |
---|
88 | |
---|
89 | @end table |
---|
90 | |
---|
91 | @subheading DESCRIPTION: |
---|
92 | |
---|
93 | @subheading NOTES: |
---|
94 | |
---|
95 | @c |
---|
96 | @c |
---|
97 | @c |
---|
98 | @page |
---|
99 | @subsection pthread_setspecific - Set Thread Specific Key Value |
---|
100 | |
---|
101 | @subheading CALLING SEQUENCE: |
---|
102 | |
---|
103 | @example |
---|
104 | #include <pthread.h> |
---|
105 | |
---|
106 | int pthread_setspecific( |
---|
107 | pthread_key_t key, |
---|
108 | const void *value |
---|
109 | ); |
---|
110 | @end example |
---|
111 | |
---|
112 | @subheading STATUS CODES: |
---|
113 | @table @b |
---|
114 | @item EINVAL |
---|
115 | The specified key is invalid. |
---|
116 | |
---|
117 | @end table |
---|
118 | |
---|
119 | @subheading DESCRIPTION: |
---|
120 | |
---|
121 | @subheading NOTES: |
---|
122 | |
---|
123 | @c |
---|
124 | @c |
---|
125 | @c |
---|
126 | @page |
---|
127 | @subsection pthread_getspecific - Get Thread Specific Key Value |
---|
128 | |
---|
129 | @subheading CALLING SEQUENCE: |
---|
130 | |
---|
131 | @example |
---|
132 | #include <pthread.h> |
---|
133 | |
---|
134 | void *pthread_getspecific( |
---|
135 | pthread_key_t key |
---|
136 | ); |
---|
137 | @end example |
---|
138 | |
---|
139 | @subheading STATUS CODES: |
---|
140 | @table @b |
---|
141 | @item NULL |
---|
142 | There is no thread-specific data associated with the specified key. |
---|
143 | |
---|
144 | @item non-NULL |
---|
145 | The data associated with the specified key. |
---|
146 | |
---|
147 | @end table |
---|
148 | |
---|
149 | @subheading DESCRIPTION: |
---|
150 | |
---|
151 | @subheading NOTES: |
---|
152 | |
---|