share/man/man3c/pthread_attr_getinheritsched.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1991, 1992, 1994, The X/Open Company Ltd.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH PTHREAD_ATTR_GETINHERITSCHED 3C "Mar 23, 2005"
  48 .SH NAME
  49 pthread_attr_getinheritsched, pthread_attr_setinheritsched \- get or set
  50 inheritsched attribute
  51 .SH SYNOPSIS
  52 .LP
  53 .nf
  54 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  55 #include <pthread.h>
  56
  57 \fBint\fR \fBpthread_attr_getinheritsched\fR(\fBconst pthread_attr_t *restrict\fR \fIattr\fR,
  58      \fBint *restrict\fR \fIinheritsched\fR);
  59 .fi
  60
  61 .LP
  62 .nf
  63 \fBint\fR \fBpthread_attr_setinheritsched\fR(\fBpthread_attr_t *\fR\fIattr\fR, \fBint\fR \fIinheritsched\fR);
  64 .fi
  65
  66 .SH DESCRIPTION
  67 .sp
  68 .LP
  69 The functions \fBpthread_attr_setinheritsched()\fR and
  70 \fBpthread_attr_getinheritsched()\fR, respectively, set and get the
  71 \fIinheritsched\fR attribute in the \fIattr\fR argument.
  72 .sp
  73 .LP
  74 When the attribute objects are used by \fBpthread_create()\fR, the
  75 \fIinheritsched\fR attribute determines how the other scheduling attributes of
  76 the created thread are to be set:
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBPTHREAD_INHERIT_SCHED\fR \fR
  81 .ad
  82 .RS 27n
  83 Specifies that the scheduling policy and associated attributes are to be
  84 inherited from the creating thread, and the scheduling attributes in this
  85 \fIattr\fR argument are to be ignored.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBPTHREAD_EXPLICIT_SCHED\fR \fR
  92 .ad
  93 .RS 27n
  94 Specifies that the scheduling policy and associated attributes are to be set to
  95 the corresponding values from this attribute object.
  96 .RE
  97
  98 .sp
  99 .LP
 100 The symbols  \fBPTHREAD_INHERIT_SCHED\fR and  \fBPTHREAD_EXPLICIT_SCHED\fR are
 101 defined in the header \fB<pthread.h>\fR\&.
 102 .SH RETURN VALUES
 103 .sp
 104 .LP
 105 If successful, the \fBpthread_attr_setinheritsched()\fR and
 106 \fBpthread_attr_getinheritsched()\fR functions return  \fB0\fR. Otherwise, an
 107 error number is returned to indicate the error.
 108 .SH ERRORS
 109 .sp
 110 .LP
 111 The \fBpthread_attr_setinheritsched()\fR or
 112 \fBpthread_attr_getinheritsched()\fR functions may fail if:
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fBEINVAL\fR\fR
 117 .ad
 118 .RS 10n
 119 \fIattr\fR or \fIinheritsched\fR is invalid.
 120 .RE
 121
 122 .SH USAGE
 123 .sp
 124 .LP
 125 After these attributes have been set, a thread can be created with the
 126 specified attributes using \fBpthread_create()\fR. Using these routines does
 127 not affect the current running thread.
 128 .SH ATTRIBUTES
 129 .sp
 130 .LP
 131 See \fBattributes\fR(5) for descriptions of the following attributes:
 132 .sp
 133
 134 .sp
 135 .TS
 136 box;
 137 c | c
 138 l | l .
 139 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 140 _
 141 Interface Stability     Standard
 142 _
 143 MT-Level        MT-Safe
 144 .TE
 145
 146 .SH SEE ALSO
 147 .sp
 148 .LP
 149 \fBpthread_attr_getschedparam\fR(3C), \fBpthread_attr_init\fR(3C),
 150 \fBpthread_attr_setscope\fR(3C), \fBpthread_attr_setschedpolicy\fR(3C),
 151 \fBpthread_create\fR(3C), \fBpthread_setschedparam\fR(3C), \fBattributes\fR(5),
 152 \fBstandards\fR(5)