xref: /titanic_41/usr/src/man/man3c/posix_spawnattr_getschedparam.3c (revision 2c2d21e98a95cba5687ec6574c974a5c6c4a6adb)
te
Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
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
http://www.opengroup.org/bookstore/.
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.
This notice shall appear on any product containing this material.
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.
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.
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]
POSIX_SPAWNATTR_GETSCHEDPARAM 3C "Jan 30, 2004"
NAME
posix_spawnattr_getschedparam, posix_spawnattr_setschedparam - get and set spawn-schedparam attribute of spawn attributes object
SYNOPSIS

#include <spawn.h>
#include <sched.h>

int posix_spawnattr_getschedparam(const posix_spawnattr_t *restrict attr,
 struct sched_param *restrict schedparam);

int posix_spawnattr_setschedparam(posix_spawnattr_t *restrict attr,
 const struct sched_param *restrict schedparam);
DESCRIPTION

The posix_spawnattr_getschedparam() function obtains the value of the spawn-schedparam attribute from the attributes object referenced by attr.

The posix_spawnattr_setschedparam() function sets the spawn-schedparam attribute in an initialized attributes object referenced by attr.

The spawn-schedparam attribute represents the scheduling parameters to be assigned to the new process image in a spawn operation (if POSIX_SPAWN_SETSCHEDULER or POSIX_SPAWN_SETSCHEDPARAM is set in the spawn-flags attribute). The default value of this attribute is unspecified.

RETURN VALUES

Upon successful completion, posix_spawnattr_getschedparam() returns 0 and stores the value of the spawn-schedparam attribute of attr into the object referenced by the schedparam parameter. Otherwise, an error number is returned to indicate the error.

Upon successful completion, posix_spawnattr_setschedparam() returns 0. Otherwise, an error number is returned to indicate the error.

ERRORS

These functions may fail if: EINVAL

The value specified by attr is invalid.

The posix_spawnattr_setschedparam() function may fail if: EINVAL

The value of the attribute being set is not valid.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level MT-Safe
SEE ALSO

posix_spawn(3C), posix_spawnattr_destroy(3C), posix_spawnattr_getflags(3C), posix_spawnattr_getpgroup(3C), posix_spawnattr_getschedpolicy(3C), posix_spawnattr_getsigdefault(3C), posix_spawnattr_getsigmask(3C), attributes(5), standards(5)