summaryrefslogtreecommitdiffstats
path: root/templates/man3/pthread_key_create.3.pot
blob: a7d6459142c0a32423831c2b25a9cd1684ddfd42 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# SOME DESCRIPTIVE TITLE
# Copyright (C) YEAR Free Software Foundation, Inc.
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"POT-Creation-Date: 2024-03-01 17:04+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#. type: TH
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
#, no-wrap
msgid "pthread_key_create"
msgstr ""

#. type: TH
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
#, no-wrap
msgid "2023-11-24"
msgstr ""

#. type: TH
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
#, no-wrap
msgid "Linux man-pages 6.06"
msgstr ""

#. type: SH
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
#, no-wrap
msgid "NAME"
msgstr ""

#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
msgid ""
"pthread_key_create, pthread_key_delete, pthread_setspecific, "
"pthread_getspecific - management of thread-specific data"
msgstr ""

#. type: SH
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
#, no-wrap
msgid "SYNOPSIS"
msgstr ""

#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
msgid "B<#include E<lt>pthread.hE<gt>>"
msgstr ""

#. type: Plain text
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
msgid ""
"B<int pthread_key_create(pthread_key_t *>I<key>B<, void "
"(*>I<destr_function>B<) (void *));> B<int pthread_key_delete(pthread_key_t "
">I<key>B<);> B<int pthread_setspecific(pthread_key_t >I<key>B<, const void "
"*>I<pointer>B<);> B<void * pthread_getspecific(pthread_key_t >I<key>B<);>"
msgstr ""

#. type: SH
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
#, no-wrap
msgid "DESCRIPTION"
msgstr ""

#. type: Plain text
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
msgid ""
"Programs often need global or static variables that have different values in "
"different threads.  Since threads share one memory space, this cannot be "
"achieved with regular variables.  Thread-specific data is the POSIX threads "
"answer to this need."
msgstr ""

#. type: Plain text
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
msgid ""
"Each thread possesses a private memory block, the thread-specific data area, "
"or TSD area for short.  This area is indexed by TSD keys.  The TSD area "
"associates values of type B<void *> to TSD keys.  TSD keys are common to all "
"threads, but the value associated with a given TSD key can be different in "
"each thread."
msgstr ""

#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
msgid ""
"For concreteness, the TSD areas can be viewed as arrays of B<void *> "
"pointers, TSD keys as integer indices into these arrays, and the value of a "
"TSD key as the value of the corresponding array element in the calling "
"thread."
msgstr ""

#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
msgid ""
"When a thread is created, its TSD area initially associates B<NULL> with all "
"keys."
msgstr ""

#. type: Plain text
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
msgid ""
"B<pthread_key_create> allocates a new TSD key.  The key is stored in the "
"location pointed to by I<key>.  There is a limit of B<PTHREAD_KEYS_MAX> on "
"the number of keys allocated at a given time.  The value initially "
"associated with the returned key is B<NULL> in all currently executing "
"threads."
msgstr ""

#. type: Plain text
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
msgid ""
"The I<destr_function> argument, if not B<NULL>, specifies a destructor "
"function associated with the key.  When a thread terminates via "
"B<pthread_exit> or by cancellation, I<destr_function> is called with "
"arguments the value associated with the key in that thread.  The "
"I<destr_function> is not called if that value is B<NULL>.  The order in "
"which destructor functions are called at thread termination time is "
"unspecified."
msgstr ""

#. type: Plain text
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
msgid ""
"Before the destructor function is called, the B<NULL> value is associated "
"with the key in the current thread.  A destructor function might, however, "
"re-associate non-B<NULL> values to that key or some other key.  To deal with "
"this, if after all the destructors have been called for all non-B<NULL> "
"values, there are still some non-B<NULL> values with associated destructors, "
"then the process is repeated.  The glibc implementation stops the process "
"after B<PTHREAD_DESTRUCTOR_ITERATIONS> iterations, even if some non-B<NULL> "
"values with associated descriptors remain.  Other implementations may loop "
"indefinitely."
msgstr ""

#. type: Plain text
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
msgid ""
"B<pthread_key_delete> deallocates a TSD key.  It does not check whether non-"
"B<NULL> values are associated with that key in the currently executing "
"threads, nor call the destructor function associated with the key."
msgstr ""

#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
msgid ""
"B<pthread_setspecific> changes the value associated with I<key> in the "
"calling thread, storing the given I<pointer> instead."
msgstr ""

#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
msgid ""
"B<pthread_getspecific> returns the value currently associated with I<key> in "
"the calling thread."
msgstr ""

#. type: SH
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
#, no-wrap
msgid "RETURN VALUE"
msgstr ""

#. type: Plain text
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
msgid ""
"B<pthread_key_create>, B<pthread_key_delete>, and B<pthread_setspecific> "
"return 0 on success and a non-zero error code on failure.  If successful, "
"B<pthread_key_create> stores the newly allocated key in the location pointed "
"to by its I<key> argument."
msgstr ""

#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
msgid ""
"B<pthread_getspecific> returns the value associated with I<key> on success, "
"and B<NULL> on error."
msgstr ""

#. type: SH
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
#, no-wrap
msgid "ERRORS"
msgstr ""

#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
msgid "B<pthread_key_create> returns the following error code on error:"
msgstr ""

#. type: TP
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
#, no-wrap
msgid "B<EAGAIN>"
msgstr ""

#. type: Plain text
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
msgid "B<PTHREAD_KEYS_MAX> keys are already allocated."
msgstr ""

#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
msgid ""
"B<pthread_key_delete> and B<pthread_setspecific> return the following error "
"code on error:"
msgstr ""

#. type: TP
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
#, no-wrap
msgid "B<EINVAL>"
msgstr ""

#. type: Plain text
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
msgid "I<key> is not a valid, allocated TSD key."
msgstr ""

#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
msgid ""
"B<pthread_getspecific> returns B<NULL> if I<key> is not a valid, allocated "
"TSD key."
msgstr ""

#. type: SH
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
#, no-wrap
msgid "SEE ALSO"
msgstr ""

#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
msgid "pthread_create(3), pthread_exit(3), pthread_testcancel(3)."
msgstr ""

#. type: SH
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron
#, no-wrap
msgid "EXAMPLE"
msgstr ""

#. type: Plain text
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
msgid ""
"The following code fragment allocates a thread-specific array of 100 "
"characters, with automatic reclamation at thread exit:"
msgstr ""

#. type: Plain text
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
#, no-wrap
msgid ""
"B</* Key for the thread-specific buffer */\n"
"static pthread_key_t buffer_key;\n"
"\\&\n"
"/* Once-only initialisation of the key */\n"
"static pthread_once_t buffer_key_once = PTHREAD_ONCE_INIT;\n"
"\\&\n"
"/* Allocate the thread-specific buffer */\n"
"void buffer_alloc(void)\n"
"{\n"
"  pthread_once(&buffer_key_once, buffer_key_alloc);\n"
"  pthread_setspecific(buffer_key, malloc(100));\n"
"}\n"
"\\&\n"
"/* Return the thread-specific buffer */\n"
"char * get_buffer(void)\n"
"{\n"
"  return (char *) pthread_getspecific(buffer_key);\n"
"}\n"
"\\&\n"
"/* Allocate the key */\n"
"static void buffer_key_alloc()\n"
"{\n"
"  pthread_key_create(&buffer_key, buffer_destroy);\n"
"}\n"
"\\&\n"
"/* Free the thread-specific buffer */\n"
"static void buffer_destroy(void * buf)\n"
"{\n"
"  free(buf);\n"
"}>\n"
msgstr ""

#. type: TH
#: debian-bookworm debian-unstable
#, no-wrap
msgid "PTHREAD_SPECIFIC"
msgstr ""

#. type: TH
#: debian-bookworm debian-unstable
#, no-wrap
msgid "LinuxThreads"
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
msgid ""
"B<int pthread_key_create(pthread_key_t *>I<key>B<, void "
"(*>I<destr_function>B<) (void *));>"
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
msgid "B<int pthread_key_delete(pthread_key_t >I<key>B<);>"
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
msgid ""
"B<int pthread_setspecific(pthread_key_t >I<key>B<, const void "
"*>I<pointer>B<);>"
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
msgid "B<void * pthread_getspecific(pthread_key_t >I<key>B<);>"
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
msgid ""
"Programs often need global or static variables that have different values in "
"different threads. Since threads share one memory space, this cannot be "
"achieved with regular variables. Thread-specific data is the POSIX threads "
"answer to this need."
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
msgid ""
"Each thread possesses a private memory block, the thread-specific data area, "
"or TSD area for short. This area is indexed by TSD keys. The TSD area "
"associates values of type B<void *> to TSD keys. TSD keys are common to all "
"threads, but the value associated with a given TSD key can be different in "
"each thread."
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
msgid ""
"B<pthread_key_create> allocates a new TSD key. The key is stored in the "
"location pointed to by I<key>. There is a limit of B<PTHREAD_KEYS_MAX> on "
"the number of keys allocated at a given time. The value initially associated "
"with the returned key is B<NULL> in all currently executing threads."
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
msgid ""
"The I<destr_function> argument, if not B<NULL>, specifies a destructor "
"function associated with the key. When a thread terminates via "
"B<pthread_exit> or by cancellation, I<destr_function> is called with "
"arguments the value associated with the key in that thread. The "
"I<destr_function> is not called if that value is B<NULL>. The order in which "
"destructor functions are called at thread termination time is unspecified."
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
msgid ""
"Before the destructor function is called, the B<NULL> value is associated "
"with the key in the current thread.  A destructor function might, however, "
"re-associate non-B<NULL> values to that key or some other key.  To deal with "
"this, if after all the destructors have been called for all non-B<NULL> "
"values, there are still some non-B<NULL> values with associated destructors, "
"then the process is repeated.  The LinuxThreads implementation stops the "
"process after B<PTHREAD_DESTRUCTOR_ITERATIONS> iterations, even if some non-"
"B<NULL> values with associated descriptors remain.  Other implementations "
"may loop indefinitely."
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
msgid ""
"B<pthread_key_delete> deallocates a TSD key. It does not check whether non-"
"B<NULL> values are associated with that key in the currently executing "
"threads, nor call the destructor function associated with the key."
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
msgid ""
"B<pthread_key_create>, B<pthread_key_delete>, and B<pthread_setspecific> "
"return 0 on success and a non-zero error code on failure. If successful, "
"B<pthread_key_create> stores the newly allocated key in the location pointed "
"to by its I<key> argument."
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
msgid "B<PTHREAD_KEYS_MAX> keys are already allocated"
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
msgid "I<key> is not a valid, allocated TSD key"
msgstr ""

#. type: SH
#: debian-bookworm debian-unstable
#, no-wrap
msgid "AUTHOR"
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
msgid "Xavier Leroy E<lt>Xavier.Leroy@inria.frE<gt>"
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
msgid ""
"The following code fragment allocates a thread-specific array of 100 "
"characters, with automatic reclaimation at thread exit:"
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
#, no-wrap
msgid ""
"B</* Key for the thread-specific buffer */\n"
"static pthread_key_t buffer_key;>\n"
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
#, no-wrap
msgid ""
"B</* Once-only initialisation of the key */\n"
"static pthread_once_t buffer_key_once = PTHREAD_ONCE_INIT;>\n"
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
#, no-wrap
msgid ""
"B</* Allocate the thread-specific buffer */\n"
"void buffer_alloc(void)\n"
"{\n"
"  pthread_once(&buffer_key_once, buffer_key_alloc);\n"
"  pthread_setspecific(buffer_key, malloc(100));\n"
"}>\n"
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
#, no-wrap
msgid ""
"B</* Return the thread-specific buffer */\n"
"char * get_buffer(void)\n"
"{\n"
"  return (char *) pthread_getspecific(buffer_key);\n"
"}>\n"
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
#, no-wrap
msgid ""
"B</* Allocate the key */\n"
"static void buffer_key_alloc()\n"
"{\n"
"  pthread_key_create(&buffer_key, buffer_destroy);\n"
"}>\n"
msgstr ""

#. type: Plain text
#: debian-bookworm debian-unstable
#, no-wrap
msgid ""
"B</* Free the thread-specific buffer */\n"
"static void buffer_destroy(void * buf)\n"
"{\n"
"  free(buf);\n"
"}>\n"
msgstr ""