File: pthread_join.3

package info (click to toggle)
rtlinux 3.1pre3-2
  • links: PTS
  • area: non-free
  • in suites: sarge, woody
  • size: 4,892 kB
  • ctags: 4,228
  • sloc: ansic: 26,204; sh: 2,069; makefile: 1,414; perl: 855; tcl: 489; asm: 380; cpp: 42
file content (99 lines) | stat: -rw-r--r-- 2,857 bytes parent folder | download | duplicates (2)
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
.\" This -*- nroff -*- file has been generated from
.\" DocBook SGML with docbook-to-man on Debian GNU/Linux.
...\"
...\"	transcript compatibility for postscript use.
...\"
...\"	synopsis:  .P! <file.ps>
...\"
.de P!
\\&.
.fl			\" force out current output buffer
\\!%PB
\\!/showpage{}def
...\" the following is from Ken Flowers -- it prevents dictionary overflows
\\!/tempdict 200 dict def tempdict begin
.fl			\" prolog
.sy cat \\$1\" bring in postscript file
...\" the following line matches the tempdict above
\\!end % tempdict %
\\!PE
\\!.
.sp \\$2u	\" move below the image
..
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
'\" t 
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n  
.TH "pthread_join" "3" 
.SH "NAME" 
pthread_join \(em create a thread 
.SH "SYNOPSIS" 
.PP 
.nf 
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
#include <rtl_sched.h> 
 
int \fBpthread_join\fP(pthread_t \fBthread\fR, void \fB**arg\fR); 
.fi 
.SH "DESCRIPTION" 
.PP 
This function is an RTLinux version of standard POSIX threads function.  
\fBpthread_join\fP suspends the calling thread until the target thread terminates. 
If arg is not NULL, the return value of the target thread will be (*arg) on return. If the target 
thread is terminated already, \fBpthread_join\fP returns immediately. 
On a non-failure return, the target thread is guaranteed to be terminated already.  There is, of course, 
no upper bound on how long this call may take. 
.SH "RETURN VALUE" 
.PP 
\fBpthread_join\fP returns 0 on success and a non-zero error code on error. 
.SH "ERRORS" 
.IP "[EINVAL]" 10 
The target is not a joinable thread.  
 
.IP " [ESRCH]" 10 
No such thread. 
.IP " [EDADLK]" 10 
The target thread is the calling thread. POSIX also uses this for when the OS 
detects other deadlocks, but RTLinux does not try to detect deadlock.  Just write good code.. 
.SH "AUTHOR" 
.PP 
Victor Yodaiken (\fIsupport@fsmlabs.com (link to URL mailto:support@fsmlabs.com) \fR) 
.SH "NOTES" 
.PP 
\fBpthread_join\fP is not all that useful at this time. Buttenhof's book on thread programming essentially suggests that you never use it. In future plans, we hope to use it for fault tolerance support. 
.SH "SEE ALSO" 
\fIUNIX spec pthread_join(3) (link to URL ../susv2/xsh/pthread_join.html) \fR, \fIpthread_make_periodic_np(3) (link to URL pthread_make_periodic_np.3.html) \fR 
.PP 
\(co2001 FSMLabs Inc. 
.PP 
All rights reserved. 
...\" created by instant / docbook-to-man, Wed 13 Jun 2001, 17:57