diff options
Diffstat (limited to 'man-pages-posix-2003/man3p/pthread_attr_getscope.3p')
-rw-r--r-- | man-pages-posix-2003/man3p/pthread_attr_getscope.3p | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/man-pages-posix-2003/man3p/pthread_attr_getscope.3p b/man-pages-posix-2003/man3p/pthread_attr_getscope.3p new file mode 100644 index 0000000..37c9dc1 --- /dev/null +++ b/man-pages-posix-2003/man3p/pthread_attr_getscope.3p @@ -0,0 +1,87 @@ +.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved +.TH "PTHREAD_ATTR_GETSCOPE" 3P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual" +.\" pthread_attr_getscope +.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_attr_getscope, pthread_attr_setscope \- get and set the contentionscope +attribute (\fBREALTIME +THREADS\fP) +.SH SYNOPSIS +.LP +\fB#include <pthread.h> +.br +.sp +int pthread_attr_getscope(const pthread_attr_t *restrict\fP \fIattr\fP\fB, +.br +\ \ \ \ \ \ int *restrict\fP \fIcontentionscope\fP\fB); +.br +int pthread_attr_setscope(pthread_attr_t *\fP\fIattr\fP\fB, int\fP +\fIcontentionscope\fP\fB); \fP +\fB +.br +\fP +.SH DESCRIPTION +.LP +The \fIpthread_attr_getscope\fP() and \fIpthread_attr_setscope\fP() +functions, respectively, shall get and set the +\fIcontentionscope\fP attribute in the \fIattr\fP object. +.LP +The \fIcontentionscope\fP attribute may have the values PTHREAD_SCOPE_SYSTEM, +signifying system scheduling contention scope, or +PTHREAD_SCOPE_PROCESS, signifying process scheduling contention scope. +The symbols PTHREAD_SCOPE_SYSTEM and PTHREAD_SCOPE_PROCESS +are defined in the \fI<pthread.h>\fP header. +.SH RETURN VALUE +.LP +If successful, the \fIpthread_attr_getscope\fP() and \fIpthread_attr_setscope\fP() +functions shall return zero; otherwise, an +error number shall be returned to indicate the error. +.SH ERRORS +.LP +The \fIpthread_attr_setscope\fP() function may fail if: +.TP 7 +.B EINVAL +The value of \fIcontentionscope\fP is not valid. +.TP 7 +.B ENOTSUP +An attempt was made to set the attribute to an unsupported value. +.sp +.LP +These functions shall not return an error code of [EINTR]. +.LP +\fIThe following sections are informative.\fP +.SH EXAMPLES +.LP +None. +.SH APPLICATION USAGE +.LP +After these attributes have been set, a thread can be created with +the specified attributes using \fIpthread_create\fP(). Using these +routines does not affect the current running +thread. +.SH RATIONALE +.LP +None. +.SH FUTURE DIRECTIONS +.LP +None. +.SH SEE ALSO +.LP +\fIpthread_attr_destroy\fP(), \fIpthread_attr_getinheritsched\fP(), +\fIpthread_attr_getschedpolicy\fP(), \fIpthread_attr_getschedparam\fP(), +\fIpthread_create\fP(), the Base Definitions volume of IEEE\ Std\ 1003.1-2001, +\fI<pthread.h>\fP, \fI<sched.h>\fP +.SH COPYRIGHT +Portions of this text are reprinted and reproduced in electronic form +from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology +-- Portable Operating System Interface (POSIX), The Open Group Base +Specifications Issue 6, Copyright (C) 2001-2003 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 . |