summaryrefslogtreecommitdiffstats
path: root/man3/pthread_equal.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--man3/pthread_equal.358
1 files changed, 58 insertions, 0 deletions
diff --git a/man3/pthread_equal.3 b/man3/pthread_equal.3
new file mode 100644
index 0000000..976e273
--- /dev/null
+++ b/man3/pthread_equal.3
@@ -0,0 +1,58 @@
+'\" t
+.\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
+.\" <mtk.manpages@gmail.com>
+.\"
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
+.\"
+.TH pthread_equal 3 2023-07-20 "Linux man-pages 6.05.01"
+.SH NAME
+pthread_equal \- compare thread IDs
+.SH LIBRARY
+POSIX threads library
+.RI ( libpthread ", " \-lpthread )
+.SH SYNOPSIS
+.nf
+.B #include <pthread.h>
+.PP
+.BI "int pthread_equal(pthread_t " t1 ", pthread_t " t2 );
+.fi
+.SH DESCRIPTION
+The
+.BR pthread_equal ()
+function compares two thread identifiers.
+.SH RETURN VALUE
+If the two thread IDs are equal,
+.BR pthread_equal ()
+returns a nonzero value; otherwise, it returns 0.
+.SH ERRORS
+This function always succeeds.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface Attribute Value
+T{
+.na
+.nh
+.BR pthread_equal ()
+T} Thread safety MT-Safe
+.TE
+.sp 1
+.SH STANDARDS
+POSIX.1-2008.
+.SH HISTORY
+POSIX.1-2001.
+.SH NOTES
+The
+.BR pthread_equal ()
+function is necessary because thread IDs should be considered opaque:
+there is no portable way for applications to directly compare two
+.I pthread_t
+values.
+.SH SEE ALSO
+.BR pthread_create (3),
+.BR pthread_self (3),
+.BR pthreads (7)