logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

pthread_getcpuclockid.3p (2544B)

    

  1. '\" et
  2. .TH PTHREAD_GETCPUCLOCKID "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. pthread_getcpuclockid
  12. \(em access a thread CPU-time clock
  13. (\fBADVANCED REALTIME THREADS\fP)
  14. .SH SYNOPSIS
  15. .LP
  16. .nf
  17. #include <pthread.h>
  18. #include <time.h>
  19. .P
  20. int pthread_getcpuclockid(pthread_t \fIthread_id\fP, clockid_t *\fIclock_id\fP);
  21. .fi
  22. .SH DESCRIPTION
  23. The
  24. \fIpthread_getcpuclockid\fR()
  25. function shall return in
  26. .IR clock_id
  27. the clock ID of the CPU-time clock of the thread specified by
  28. .IR thread_id ,
  29. if the thread specified by
  30. .IR thread_id
  31. exists.
  32. .SH "RETURN VALUE"
  33. Upon successful completion,
  34. \fIpthread_getcpuclockid\fR()
  35. shall return zero; otherwise, an error number shall be returned to
  36. indicate the error.
  37. .SH ERRORS
  38. No errors are defined.
  39. .LP
  40. .IR "The following sections are informative."
  41. .SH EXAMPLES
  42. None.
  43. .SH "APPLICATION USAGE"
  44. The
  45. \fIpthread_getcpuclockid\fR()
  46. function is part of the Thread CPU-Time Clocks option and need not be
  47. provided on all implementations.
  48. .SH RATIONALE
  49. If an implementation detects use of a thread ID after the end of its
  50. lifetime, it is recommended that the function should fail and report an
  51. .BR [ESRCH] 
  52. error.
  53. .SH "FUTURE DIRECTIONS"
  54. None.
  55. .SH "SEE ALSO"
  56. .IR "\fIclock_getcpuclockid\fR\^(\|)",
  57. .IR "\fIclock_getres\fR\^(\|)",
  58. .IR "\fItimer_create\fR\^(\|)"
  59. .P
  60. The Base Definitions volume of POSIX.1\(hy2017,
  61. .IR "\fB<pthread.h>\fP",
  62. .IR "\fB<time.h>\fP"
  63. .\"
  64. .SH COPYRIGHT
  65. Portions of this text are reprinted and reproduced in electronic form
  66. from IEEE Std 1003.1-2017, Standard for Information Technology
  67. -- Portable Operating System Interface (POSIX), The Open Group Base
  68. Specifications Issue 7, 2018 Edition,
  69. Copyright (C) 2018 by the Institute of
  70. Electrical and Electronics Engineers, Inc and The Open Group.
  71. In the event of any discrepancy between this version and the original IEEE and
  72. The Open Group Standard, the original IEEE and The Open Group Standard
  73. is the referee document. The original Standard can be obtained online at
  74. http://www.opengroup.org/unix/online.html .
  75. .PP
  76. Any typographical or formatting errors that appear
  77. in this page are most likely
  78. to have been introduced during the conversion of the source files to
  79. man page format. To report such errors, see
  80. https://www.kernel.org/doc/man-pages/reporting_bugs.html .