posix_spawnattr_getschedparam(3p) — Linux manual page

PROLOG | NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | EXAMPLES | APPLICATION USAGE | RATIONALE | FUTURE DIRECTIONS | SEE ALSO | COPYRIGHT

POSIX_SPAWNATTR_GETSCHEDPARAM(3P)grammer'sIManualNATTR_GETSCHEDPARAM(3P)

PROLOG         top

       This manual page is part of the POSIX Programmer's Manual.  The
       Linux implementation of this interface may differ (consult the
       corresponding Linux manual page for details of Linux behavior),
       or the interface may not be implemented on Linux.

NAME         top

       posix_spawnattr_getschedparam, posix_spawnattr_setschedparam —
       get and set the spawn-schedparam attribute of a spawn attributes
       object (ADVANCED REALTIME)

SYNOPSIS         top

       #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         top

       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         top

       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         top

       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.

       The following sections are informative.

EXAMPLES         top

       None.

APPLICATION USAGE         top

       These functions are part of the Spawn and Process Scheduling
       options and need not be provided on all implementations.

RATIONALE         top

       None.

FUTURE DIRECTIONS         top

       None.

SEE ALSO         top

       posix_spawn(3p), posix_spawnattr_destroy(3p),
       posix_spawnattr_getsigdefault(3p), posix_spawnattr_getflags(3p),
       posix_spawnattr_getpgroup(3p),
       posix_spawnattr_getschedpolicy(3p),
       posix_spawnattr_getsigmask(3p)

       The Base Definitions volume of POSIX.1‐2017, sched.h(0p),
       spawn.h(0p)

COPYRIGHT         top

       Portions of this text are reprinted and reproduced in electronic
       form from IEEE Std 1003.1-2017, Standard for Information
       Technology -- Portable Operating System Interface (POSIX), The
       Open Group Base Specifications Issue 7, 2018 Edition, Copyright
       (C) 2018 by the Institute of Electrical and Electronics
       Engineers, Inc and The Open Group.  In the event of any
       discrepancy between this version 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 .

       Any typographical or formatting errors that appear in this page
       are most likely to have been introduced during the conversion of
       the source files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .

IEEE/The Open Group               2017 POSIX_SPAWNATTR_GETSCHEDPARAM(3P)

Pages that refer to this page: spawn.h(0p)posix_spawn(3p)posix_spawnattr_destroy(3p)posix_spawnattr_getflags(3p)posix_spawnattr_getpgroup(3p)posix_spawnattr_getschedpolicy(3p)posix_spawnattr_getsigdefault(3p)posix_spawnattr_getsigmask(3p)posix_spawnattr_setschedparam(3p)