usr/src/man/man3c/posix_spawnattr_getschedparam.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 (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH POSIX_SPAWNATTR_GETSCHEDPARAM 3C "Jan 30, 2004"
  47 .SH NAME
  48 posix_spawnattr_getschedparam, posix_spawnattr_setschedparam \- get and set
  49 spawn-schedparam attribute of spawn attributes object
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <spawn.h>
  54 #include <sched.h>
  55
  56 \fBint\fR \fBposix_spawnattr_getschedparam\fR(\fBconst posix_spawnattr_t *restrict\fR \fIattr\fR,
  57      \fBstruct sched_param *restrict\fR \fIschedparam\fR);
  58 .fi
  59
  60 .LP
  61 .nf
  62 \fBint\fR \fBposix_spawnattr_setschedparam\fR(\fBposix_spawnattr_t *restrict\fR \fIattr\fR,
  63      \fBconst struct sched_param *restrict\fR \fIschedparam\fR);
  64 .fi
  65
  66 .SH DESCRIPTION
  67 .sp
  68 .LP
  69 The \fBposix_spawnattr_getschedparam()\fR function obtains the value of the
  70 \fIspawn-schedparam\fR attribute from the attributes object referenced by
  71 \fIattr\fR.
  72 .sp
  73 .LP
  74 The \fBposix_spawnattr_setschedparam()\fR function sets the
  75 \fIspawn-schedparam\fR attribute in an initialized attributes object referenced
  76 by \fIattr\fR.
  77 .sp
  78 .LP
  79 The \fIspawn-schedparam\fR attribute represents the scheduling parameters to be
  80 assigned to the new process image in a spawn operation (if
  81 \fBPOSIX_SPAWN_SETSCHEDULER\fR or \fBPOSIX_SPAWN_SETSCHEDPARAM\fR is set in the
  82 \fIspawn-flags\fR attribute). The default value of this attribute is
  83 unspecified.
  84 .SH RETURN VALUES
  85 .sp
  86 .LP
  87 Upon successful completion, \fBposix_spawnattr_getschedparam()\fR returns 0 and
  88 stores the value of the \fIspawn-schedparam\fR attribute of \fIattr\fR into the
  89 object referenced by the \fIschedparam\fR parameter. Otherwise, an error number
  90 is returned to indicate the error.
  91 .sp
  92 .LP
  93 Upon successful completion, \fBposix_spawnattr_setschedparam()\fR returns 0.
  94 Otherwise, an error number is returned to indicate the error.
  95 .SH ERRORS
  96 .sp
  97 .LP
  98 These functions may fail if:
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBEINVAL\fR\fR
 103 .ad
 104 .RS 10n
 105 The value specified by \fIattr\fR is invalid.
 106 .RE
 107
 108 .sp
 109 .LP
 110 The \fBposix_spawnattr_setschedparam()\fR function may fail if:
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBEINVAL\fR\fR
 115 .ad
 116 .RS 10n
 117 The value of the attribute being set is not valid.
 118 .RE
 119
 120 .SH ATTRIBUTES
 121 .sp
 122 .LP
 123 See \fBattributes\fR(5) for descriptions of the following attributes:
 124 .sp
 125
 126 .sp
 127 .TS
 128 box;
 129 c | c
 130 l | l .
 131 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 132 _
 133 Interface Stability     Standard
 134 _
 135 MT-Level        MT-Safe
 136 .TE
 137
 138 .SH SEE ALSO
 139 .sp
 140 .LP
 141 \fBposix_spawn\fR(3C), \fBposix_spawnattr_destroy\fR(3C),
 142 \fBposix_spawnattr_getflags\fR(3C), \fBposix_spawnattr_getpgroup\fR(3C),
 143 \fBposix_spawnattr_getschedpolicy\fR(3C),
 144 \fBposix_spawnattr_getsigdefault\fR(3C), \fBposix_spawnattr_getsigmask\fR(3C),
 145 \fBattributes\fR(5), \fBstandards\fR(5)