usr/src/man/man3c/pthread_attr_getscope.3c

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   4 .\" Copyright 1991, 1992, 1994, The X/Open Company Ltd.
   5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions 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.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH PTHREAD_ATTR_GETSCOPE 3C "Mar 23, 2005"
  13 .SH NAME
  14 pthread_attr_getscope, pthread_attr_setscope \- get or set contentionscope
  15 attribute
  16 .SH SYNOPSIS
  17 .LP
  18 .nf
  19 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  20 #include <pthread.h>
  21
  22 \fBint\fR \fBpthread_attr_getscope\fR(\fBconst pthread_attr_t *restrict\fR \fIattr\fR,
  23      \fBint *restrict\fR \fIcontentionscope\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBint\fR \fBpthread_attr_setscope\fR(\fBpthread_attr_t *\fR\fIattr\fR, \fBint\fR \fIcontentionscope\fR);
  29 .fi
  30
  31 .SH DESCRIPTION
  32 .sp
  33 .LP
  34 The \fBpthread_attr_setscope()\fR and \fBpthread_attr_getscope()\fR functions
  35 are used to set and get the \fIcontentionscope\fR attribute in the \fIattr\fR
  36 object.
  37 .sp
  38 .LP
  39 The \fIcontentionscope\fR attribute can have the value
  40 \fBPTHREAD_SCOPE_SYSTEM\fR, signifying system scheduling contention scope, or
  41 \fBPTHREAD_SCOPE_PROCESS\fR, signifying process scheduling contention scope.
  42 .sp
  43 .LP
  44 The symbols \fBPTHREAD_SCOPE_SYSTEM\fR and \fBPTHREAD_SCOPE_PROCESS\fR are
  45 defined by the header <\fBpthread.h\fR>.
  46 .SH RETURN VALUES
  47 .sp
  48 .LP
  49 If successful, the \fBpthread_attr_setscope()\fR and
  50 \fBpthread_attr_getscope()\fR functions return \fB0\fR. Otherwise, an error
  51 number is returned to indicate the error.
  52 .SH ERRORS
  53 .sp
  54 .LP
  55 The \fBpthread_attr_setscope()\fR, or \fBpthread_attr_getscope()\fR, function
  56 may fail if:
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBEINVAL\fR\fR
  61 .ad
  62 .RS 10n
  63 \fIattr\fR or \fIcontentionscope\fR is invalid.
  64 .RE
  65
  66 .SH USAGE
  67 .sp
  68 .LP
  69 After these attributes have been set, a thread can be created with the
  70 specified attributes using \fBpthread_create()\fR. Using these routines does
  71 not affect the current running thread.
  72 .SH ATTRIBUTES
  73 .sp
  74 .LP
  75 See \fBattributes\fR(5) for descriptions of the following attributes:
  76 .sp
  77
  78 .sp
  79 .TS
  80 box;
  81 c | c
  82 l | l .
  83 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  84 _
  85 Interface Stability     Standard
  86 _
  87 MT-Level        MT-Safe
  88 .TE
  89
  90 .SH SEE ALSO
  91 .sp
  92 .LP
  93 \fBpthread_attr_init\fR(3C), \fBpthread_attr_setinheritsched\fR(3C),
  94 \fBpthread_attr_setschedpolicy\fR(3C), \fBpthread_attr_setschedparam\fR(3C),
  95 \fBpthread_create\fR(3C), \fBpthread_setschedparam\fR(3C), \fBattributes\fR(5),
  96 \fBstandards\fR(5)