NAME
posix_spawnattr_getschedparam
posix_spawnattr_setschedparam —
get and set the spawn-schedparam attribute of a spawn
attributes object (ADVANCED REALTIME)
SYNOPSIS
[SPN
PS]
#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 shall obtain the value of the spawn-schedparam
attribute from the attributes object referenced by
attr.
The posix_spawnattr_setschedparam () function shall set 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 VALUE
Upon successful completion,
posix_spawnattr_getschedparam () shall return zero
and store the value of the spawn-schedparam attribute of
attr into the object referenced by the
schedparam
parameter; otherwise, an error number shall be returned to indicate the
error.
Upon successful completion, posix_spawnattr_setschedparam () shall return zero; otherwise, an error number shall be 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.
EXAMPLES
None.
APPLICATION USAGE
These functions are part of the Spawn and Process Scheduling options and need not be provided on all implementations.
RATIONALE
None.
FUTURE DIRECTIONS
None.
SEE ALSO
posix_spawn(3), posix_spawnattr_destroy(3), posix_spawnattr_init(3), posix_spawnattr_getsigdefault(3), posix_spawnattr_getflags(3), posix_spawnattr_getpgroup(3), posix_spawnattr_getschedpolicy(3), posix_spawnattr_getsigmask(3), posix_spawnattr_setsigdefault(3), posix_spawnattr_setflags(3), posix_spawnattr_setpgroup(3), posix_spawnattr_setschedpolicy(3), posix_spawnattr_setsigmask(3), posix_spawnp(3), the Base Definitions volume of IEEE Std 1003.1-2001 (“POSIX.1”), <sched.h>, <spawn.h>
CHANGE HISTORY
First released in Issue 6. Derived from IEEE Std 1003.1d-1999.
End of informative text. footer end