summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3p/pthread_getcpuclockid.3p
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/archlinux/man3p/pthread_getcpuclockid.3p')
-rw-r--r--upstream/archlinux/man3p/pthread_getcpuclockid.3p80
1 files changed, 80 insertions, 0 deletions
diff --git a/upstream/archlinux/man3p/pthread_getcpuclockid.3p b/upstream/archlinux/man3p/pthread_getcpuclockid.3p
new file mode 100644
index 00000000..6f8b6d01
--- /dev/null
+++ b/upstream/archlinux/man3p/pthread_getcpuclockid.3p
@@ -0,0 +1,80 @@
+'\" et
+.TH PTHREAD_GETCPUCLOCKID "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.\"
+.SH PROLOG
+This manual page is part of the POSIX Programmer's Manual.
+The Linux implementation of this interface may differ (consult
+the corresponding Linux manual page for details of Linux behavior),
+or the interface may not be implemented on Linux.
+.\"
+.SH NAME
+pthread_getcpuclockid
+\(em access a thread CPU-time clock
+(\fBADVANCED REALTIME THREADS\fP)
+.SH SYNOPSIS
+.LP
+.nf
+#include <pthread.h>
+#include <time.h>
+.P
+int pthread_getcpuclockid(pthread_t \fIthread_id\fP, clockid_t *\fIclock_id\fP);
+.fi
+.SH DESCRIPTION
+The
+\fIpthread_getcpuclockid\fR()
+function shall return in
+.IR clock_id
+the clock ID of the CPU-time clock of the thread specified by
+.IR thread_id ,
+if the thread specified by
+.IR thread_id
+exists.
+.SH "RETURN VALUE"
+Upon successful completion,
+\fIpthread_getcpuclockid\fR()
+shall return zero; otherwise, an error number shall be returned to
+indicate the error.
+.SH ERRORS
+No errors are defined.
+.LP
+.IR "The following sections are informative."
+.SH EXAMPLES
+None.
+.SH "APPLICATION USAGE"
+The
+\fIpthread_getcpuclockid\fR()
+function is part of the Thread CPU-Time Clocks option and need not be
+provided on all implementations.
+.SH RATIONALE
+If an implementation detects use of a thread ID after the end of its
+lifetime, it is recommended that the function should fail and report an
+.BR [ESRCH]
+error.
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+.IR "\fIclock_getcpuclockid\fR\^(\|)",
+.IR "\fIclock_getres\fR\^(\|)",
+.IR "\fItimer_create\fR\^(\|)"
+.P
+The Base Definitions volume of POSIX.1\(hy2017,
+.IR "\fB<pthread.h>\fP",
+.IR "\fB<time.h>\fP"
+.\"
+.SH COPYRIGHT
+Portions of this text are reprinted and reproduced in electronic form
+from IEEE Std 1003.1-2017, Standard for Information Technology
+-- Portable Operating System Interface (POSIX), The Open Group Base
+Specifications Issue 7, 2018 Edition,
+Copyright (C) 2018 by the Institute of
+Electrical and Electronics Engineers, Inc and The Open Group.
+In the event of any discrepancy between this version and the original IEEE and
+The Open Group Standard, the original IEEE and The Open Group Standard
+is the referee document. The original Standard can be obtained online at
+http://www.opengroup.org/unix/online.html .
+.PP
+Any typographical or formatting errors that appear
+in this page are most likely
+to have been introduced during the conversion of the source files to
+man page format. To report such errors, see
+https://www.kernel.org/doc/man-pages/reporting_bugs.html .