usr/src/man/man3c/pthread_attr_getinheritsched.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_GETINHERITSCHED 3C "Mar 23, 2005"
  13 .SH NAME
  14 pthread_attr_getinheritsched, pthread_attr_setinheritsched \- get or set
  15 inheritsched 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_getinheritsched\fR(\fBconst pthread_attr_t *restrict\fR \fIattr\fR,
  23      \fBint *restrict\fR \fIinheritsched\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBint\fR \fBpthread_attr_setinheritsched\fR(\fBpthread_attr_t *\fR\fIattr\fR, \fBint\fR \fIinheritsched\fR);
  29 .fi
  30
  31 .SH DESCRIPTION
  32 .sp
  33 .LP
  34 The functions \fBpthread_attr_setinheritsched()\fR and
  35 \fBpthread_attr_getinheritsched()\fR, respectively, set and get the
  36 \fIinheritsched\fR attribute in the \fIattr\fR argument.
  37 .sp
  38 .LP
  39 When the attribute objects are used by \fBpthread_create()\fR, the
  40 \fIinheritsched\fR attribute determines how the other scheduling attributes of
  41 the created thread are to be set:
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fBPTHREAD_INHERIT_SCHED\fR \fR
  46 .ad
  47 .RS 27n
  48 Specifies that the scheduling policy and associated attributes are to be
  49 inherited from the creating thread, and the scheduling attributes in this
  50 \fIattr\fR argument are to be ignored.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBPTHREAD_EXPLICIT_SCHED\fR \fR
  57 .ad
  58 .RS 27n
  59 Specifies that the scheduling policy and associated attributes are to be set to
  60 the corresponding values from this attribute object.
  61 .RE
  62
  63 .sp
  64 .LP
  65 The symbols  \fBPTHREAD_INHERIT_SCHED\fR and  \fBPTHREAD_EXPLICIT_SCHED\fR are
  66 defined in the header \fB<pthread.h>\fR\&.
  67 .SH RETURN VALUES
  68 .sp
  69 .LP
  70 If successful, the \fBpthread_attr_setinheritsched()\fR and
  71 \fBpthread_attr_getinheritsched()\fR functions return  \fB0\fR. Otherwise, an
  72 error number is returned to indicate the error.
  73 .SH ERRORS
  74 .sp
  75 .LP
  76 The \fBpthread_attr_setinheritsched()\fR or
  77 \fBpthread_attr_getinheritsched()\fR functions may fail if:
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBEINVAL\fR\fR
  82 .ad
  83 .RS 10n
  84 \fIattr\fR or \fIinheritsched\fR is invalid.
  85 .RE
  86
  87 .SH USAGE
  88 .sp
  89 .LP
  90 After these attributes have been set, a thread can be created with the
  91 specified attributes using \fBpthread_create()\fR. Using these routines does
  92 not affect the current running thread.
  93 .SH ATTRIBUTES
  94 .sp
  95 .LP
  96 See \fBattributes\fR(5) for descriptions of the following attributes:
  97 .sp
  98
  99 .sp
 100 .TS
 101 box;
 102 c | c
 103 l | l .
 104 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 105 _
 106 Interface Stability     Standard
 107 _
 108 MT-Level        MT-Safe
 109 .TE
 110
 111 .SH SEE ALSO
 112 .sp
 113 .LP
 114 \fBpthread_attr_getschedparam\fR(3C), \fBpthread_attr_init\fR(3C),
 115 \fBpthread_attr_setscope\fR(3C), \fBpthread_attr_setschedpolicy\fR(3C),
 116 \fBpthread_create\fR(3C), \fBpthread_setschedparam\fR(3C), \fBattributes\fR(5),
 117 \fBstandards\fR(5)