[thirdparty/man-pages.git] / man3 / pthread_tryjoin_np.3

.\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
.\"     <mtk.manpages@gmail.com>
.\"
.\" %%%LICENSE_START(VERBATIM)
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\" %%%LICENSE_END
.\"
.TH PTHREAD_TRYJOIN_NP 3 2017-09-15 "Linux" "Linux Programmer's Manual"
.SH NAME
pthread_tryjoin_np, pthread_timedjoin_np \- try to join with a
terminated thread
.SH SYNOPSIS
.nf
.BR "#define _GNU_SOURCE" "             /* See feature_test_macros(7) */"
.B #include <pthread.h>
.PP
.BI "int pthread_tryjoin_np(pthread_t " thread ", void **" retval );
.PP
.BI "int pthread_timedjoin_np(pthread_t " thread ", void **" retval ,
.BI "                         const struct timespec *" abstime );
.fi
.PP
Compile and link with \fI\-pthread\fP.
.SH DESCRIPTION
These functions operate in the same way as
.BR pthread_join (3),
except for the differences described on this page.
.PP
The
.BR pthread_tryjoin_np ()
function performs a nonblocking join with the thread
.IR thread ,
returning the exit status of the thread in
.IR *retval .
If
.I thread
has not yet terminated, then instead of blocking, as is done by
.BR pthread_join (3),
the call returns an error.
.PP
The
.BR pthread_timedjoin_np ()
function performs a join-with-timeout.
If
.I thread
has not yet terminated,
then the call blocks until a maximum time, specified in
.IR abstime .
If the timeout expires before
.I thread
terminates,
the call returns an error.
The
.I abstime
argument is a structure of the following form,
specifying an absolute time measured since the Epoch (see
.BR time (2)):
.PP
.in +4n
.EX
struct timespec {
    time_t tv_sec;     /* seconds */
    long   tv_nsec;    /* nanoseconds */
};
.EE
.in
.SH RETURN VALUE
On success,
these functions return 0;
on error, they return an error number.
.SH ERRORS
These functions can fail with the same errors as
.BR pthread_join (3).
.BR pthread_tryjoin_np ()
can in addition fail with the following error:
.TP
.B EBUSY
.I thread
had not yet terminated at the time of the call.
.PP
.BR pthread_timedjoin_np ()
can in addition fail with the following errors:
.TP
.BR ETIMEDOUT
The call timed out before
.I thread
terminated.
.TP
.BR EINVAL
.I abstime
value is invalid
.RI ( tv_sec
is less than 0 or
.IR tv_nsec
is greater than 1e9).
.PP
.BR pthread_timedjoin_np ()
never returns the error
.BR EINTR .
.SH VERSIONS
These functions first appeared in glibc in version 2.3.3.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.ad l
.TS
allbox;
lbw22 lb lb
l l l.
Interface	Attribute	Value
T{
.BR pthread_tryjoin_np (),
.BR pthread_timedjoin_np ()
T}	Thread safety	MT-Safe
.TE
.ad
.SH CONFORMING TO
These functions are nonstandard GNU extensions;
hence the suffix "_np" (nonportable) in the names.
.SH EXAMPLE
The following code waits to join for up to 5 seconds:
.PP
.in +4n
.EX
struct timespec ts;
int s;

\&...

if (clock_gettime(CLOCK_REALTIME, &ts) == \-1) {
    /* Handle error */
}

ts.tv_sec += 5;

s = pthread_timedjoin_np(thread, NULL, &ts);
if (s != 0) {
    /* Handle error */
}
.EE
.in
.SH SEE ALSO
.BR clock_gettime (2),
.BR pthread_exit (3),
.BR pthread_join (3),
.BR pthreads (7)
Commit	Line	Data
	1	.\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
	2	.\" <mtk.manpages@gmail.com>
	3	.\"
	4	.\" %%%LICENSE_START(VERBATIM)
	5	.\" Permission is granted to make and distribute verbatim copies of this
	6	.\" manual provided the copyright notice and this permission notice are
	7	.\" preserved on all copies.
	8	.\"
	9	.\" Permission is granted to copy and distribute modified versions of this
	10	.\" manual under the conditions for verbatim copying, provided that the
	11	.\" entire resulting derived work is distributed under the terms of a
	12	.\" permission notice identical to this one.
	13	.\"
	14	.\" Since the Linux kernel and libraries are constantly changing, this
	15	.\" manual page may be incorrect or out-of-date. The author(s) assume no
	16	.\" responsibility for errors or omissions, or for damages resulting from
	17	.\" the use of the information contained herein. The author(s) may not
	18	.\" have taken the same level of care in the production of this manual,
	19	.\" which is licensed free of charge, as they might when working
	20	.\" professionally.
	21	.\"
	22	.\" Formatted or processed versions of this manual, if unaccompanied by
	23	.\" the source, must acknowledge the copyright and authors of this work.
	24	.\" %%%LICENSE_END
	25	.\"
	26	.TH PTHREAD_TRYJOIN_NP 3 2017-09-15 "Linux" "Linux Programmer's Manual"
	27	.SH NAME
	28	pthread_tryjoin_np, pthread_timedjoin_np \- try to join with a
	29	terminated thread
	30	.SH SYNOPSIS
	31	.nf
	32	.BR "#define _GNU_SOURCE" " /* See feature_test_macros(7) */"
	33	.B #include <pthread.h>
	34	.PP
	35	.BI "int pthread_tryjoin_np(pthread_t " thread ", void **" retval );
	36	.PP
	37	.BI "int pthread_timedjoin_np(pthread_t " thread ", void **" retval ,
	38	.BI " const struct timespec *" abstime );
	39	.fi
	40	.PP
	41	Compile and link with \fI\-pthread\fP.
	42	.SH DESCRIPTION
	43	These functions operate in the same way as
	44	.BR pthread_join (3),
	45	except for the differences described on this page.
	46	.PP
	47	The
	48	.BR pthread_tryjoin_np ()
	49	function performs a nonblocking join with the thread
	50	.IR thread ,
	51	returning the exit status of the thread in
	52	.IR *retval .
	53	If
	54	.I thread
	55	has not yet terminated, then instead of blocking, as is done by
	56	.BR pthread_join (3),
	57	the call returns an error.
	58	.PP
	59	The
	60	.BR pthread_timedjoin_np ()
	61	function performs a join-with-timeout.
	62	If
	63	.I thread
	64	has not yet terminated,
	65	then the call blocks until a maximum time, specified in
	66	.IR abstime .
	67	If the timeout expires before
	68	.I thread
	69	terminates,
	70	the call returns an error.
	71	The
	72	.I abstime
	73	argument is a structure of the following form,
	74	specifying an absolute time measured since the Epoch (see
	75	.BR time (2)):
	76	.PP
	77	.in +4n
	78	.EX
	79	struct timespec {
	80	time_t tv_sec; /* seconds */
	81	long tv_nsec; /* nanoseconds */
	82	};
	83	.EE
	84	.in
	85	.SH RETURN VALUE
	86	On success,
	87	these functions return 0;
	88	on error, they return an error number.
	89	.SH ERRORS
	90	These functions can fail with the same errors as
	91	.BR pthread_join (3).
	92	.BR pthread_tryjoin_np ()
	93	can in addition fail with the following error:
	94	.TP
	95	.B EBUSY
	96	.I thread
	97	had not yet terminated at the time of the call.
	98	.PP
	99	.BR pthread_timedjoin_np ()
	100	can in addition fail with the following errors:
	101	.TP
	102	.BR ETIMEDOUT
	103	The call timed out before
	104	.I thread
	105	terminated.
	106	.TP
	107	.BR EINVAL
	108	.I abstime
	109	value is invalid
	110	.RI ( tv_sec
	111	is less than 0 or
	112	.IR tv_nsec
	113	is greater than 1e9).
	114	.PP
	115	.BR pthread_timedjoin_np ()
	116	never returns the error
	117	.BR EINTR .
	118	.SH VERSIONS
	119	These functions first appeared in glibc in version 2.3.3.
	120	.SH ATTRIBUTES
	121	For an explanation of the terms used in this section, see
	122	.BR attributes (7).
	123	.ad l
	124	.TS
	125	allbox;
	126	lbw22 lb lb
	127	l l l.
	128	Interface Attribute Value
	129	T{
	130	.BR pthread_tryjoin_np (),
	131	.BR pthread_timedjoin_np ()
	132	T} Thread safety MT-Safe
	133	.TE
	134	.ad
	135	.SH CONFORMING TO
	136	These functions are nonstandard GNU extensions;
	137	hence the suffix "_np" (nonportable) in the names.
	138	.SH EXAMPLE
	139	The following code waits to join for up to 5 seconds:
	140	.PP
	141	.in +4n
	142	.EX
	143	struct timespec ts;
	144	int s;
	145
	146	\&...
	147
	148	if (clock_gettime(CLOCK_REALTIME, &ts) == \-1) {
	149	/* Handle error */
	150	}
	151
	152	ts.tv_sec += 5;
	153
	154	s = pthread_timedjoin_np(thread, NULL, &ts);
	155	if (s != 0) {
	156	/* Handle error */
	157	}
	158	.EE
	159	.in
	160	.SH SEE ALSO
	161	.BR clock_gettime (2),
	162	.BR pthread_exit (3),
	163	.BR pthread_join (3),
	164	.BR pthreads (7)