NAME

pthread_getcpuclockid - access a thread CPU-time clock (ADVANCED REALTIME THREADS)

SYNOPSIS

[TCT] #include <pthread.h>
#include <time.h>

int pthread_getcpuclockid(pthread_t thread_id, clockid_t *clock_id);

DESCRIPTION

The pthread_getcpuclockid() function shall return in clock_id the clock ID of the CPU-time clock of the thread specified by thread_id, if the thread specified by thread_id exists.

RETURN VALUE

Upon successful completion, pthread_getcpuclockid() shall return zero; otherwise, an error number shall be returned to indicate the error.

ERRORS

No errors are defined.

EXAMPLES

None.

APPLICATION USAGE

The pthread_getcpuclockid() function is part of the Thread CPU-Time Clocks option and need not be provided on all implementations.

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 [ESRCH] error.

FUTURE DIRECTIONS

None.

SEE ALSO

clock_getcpuclockid, clock_getres, timer_create

XBD <pthread.h>, <time.h>

CHANGE HISTORY

First released in Issue 6. Derived from IEEE Std 1003.1d-1999.

In the SYNOPSIS, the inclusion of <sys/types.h> is no longer required.

Issue 7

The pthread_getcpuclockid() function is marked only as part of the Thread CPU-Time Clocks option as the Threads option is now part of the Base.

Austin Group Interpretation 1003.1-2001 #142 is applied, removing the [ESRCH] error condition.

POSIX.1-2008, Technical Corrigendum 2, XSH/TC2-2008/0275 [757] is applied.