xref: /freebsd/lib/libc/gen/posix_spawnattr_getschedparam.3 (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
1.\" Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" Portions of this text are reprinted and reproduced in electronic form
26.\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology --
27.\" Portable Operating System Interface (POSIX), The Open Group Base
28.\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
29.\" Electrical and Electronics Engineers, Inc and The Open Group.  In the
30.\" event of any discrepancy between this version and the original IEEE and
31.\" The Open Group Standard, the original IEEE and The Open Group Standard is
32.\" the referee document.  The original Standard can be obtained online at
33.\"	http://www.opengroup.org/unix/online.html.
34.\"
35.Dd March 24, 2008
36.Dt POSIX_SPAWNATTR_GETSCHEDPARAM 3
37.Os
38.Sh NAME
39.Nm posix_spawnattr_getschedparam ,
40.Nm posix_spawnattr_setschedparam
41.Nd "get and set the spawn-schedparam attribute of a spawn attributes object"
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.In spawn.h
46.Ft int
47.Fn posix_spawnattr_getschedparam "const posix_spawnattr_t *restrict attr" "struct sched_param *restrict schedparam"
48.Ft int
49.Fn posix_spawnattr_setschedparam "posix_spawnattr_t *attr" "const struct sched_param *restrict schedparam"
50.Sh DESCRIPTION
51The
52.Fn posix_spawnattr_getschedparam
53function obtains the value of the spawn-schedparam attribute from the
54attributes object referenced by
55.Fa attr .
56.Pp
57The
58.Fn posix_spawnattr_setschedparam
59function sets the spawn-schedparam attribute in an initialized attributes
60object referenced by
61.Fa attr .
62.Pp
63The spawn-schedparam attribute represents the scheduling parameters to
64be assigned to the new process image in a spawn operation (if
65.Dv POSIX_SPAWN_SETSCHEDULER
66or
67.Dv POSIX_SPAWN_SETSCHEDPARAM
68is set in the spawn-flags attribute).
69The default value of this attribute is unspecified.
70.Sh RETURN VALUES
71The
72.Fn posix_spawnattr_getschedparam
73and
74.Fn posix_spawnattr_setschedparam
75functions return zero.
76.Sh SEE ALSO
77.Xr posix_spawn 3 ,
78.Xr posix_spawnattr_destroy 3 ,
79.Xr posix_spawnattr_getschedpolicy 3 ,
80.Xr posix_spawnattr_init 3 ,
81.Xr posix_spawnattr_setschedpolicy 3 ,
82.Xr posix_spawnp 3
83.Sh STANDARDS
84The
85.Fn posix_spawnattr_getschedparam
86and
87.Fn posix_spawnattr_setschedparam
88functions conform to
89.St -p1003.1-2001 .
90.Sh HISTORY
91The
92.Fn posix_spawnattr_getschedparam
93and
94.Fn posix_spawnattr_setschedparam
95functions first appeared in
96.Fx 8.0 .
97.Sh AUTHORS
98.An \&Ed Schouten Aq Mt ed@FreeBSD.org
99