bionic (3) posix_spawnattr_getschedpolicy.3posix.gz

Provided by: manpages-posix-dev_2013a-2_all bug

PROLOG
       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
       posix_spawnattr_getschedpolicy,  posix_spawnattr_setschedpolicy  —  get  and  set  the  spawn-schedpolicy
       attribute of a spawn attributes object (ADVANCED REALTIME)


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

       int posix_spawnattr_getschedpolicy(const posix_spawnattr_t
           *restrict attr, int *restrict schedpolicy);
       int posix_spawnattr_setschedpolicy(posix_spawnattr_t *attr,
           int schedpolicy);


DESCRIPTION
       The posix_spawnattr_getschedpolicy() function shall obtain the value of the  spawn-schedpolicy  attribute
       from the attributes object referenced by attr.

       The posix_spawnattr_setschedpolicy() function shall set the spawn-schedpolicy attribute in an initialized
       attributes object referenced by attr.

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


RETURN VALUE
       Upon successful completion, posix_spawnattr_getschedpolicy() shall return zero and store the value of the
       spawn-schedpolicy  attribute  of attr into the object referenced by the schedpolicy parameter; otherwise,
       an error number shall be returned to indicate the error.

       Upon successful completion, posix_spawnattr_setschedpolicy()  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_setschedpolicy() function may fail if:

       EINVAL The value of the attribute being set is not valid.

       The following sections are informative.


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(), posix_spawnattr_destroy(), posix_spawnattr_getsigdefault(), posix_spawnattr_getflags(),
       posix_spawnattr_getpgroup(), posix_spawnattr_getschedparam(), posix_spawnattr_getsigmask()

       The Base Definitions volume of POSIX.1‐2008, <sched.h>, <spawn.h>


       Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2013 Edition,
       Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open  Group  Base
       Specifications  Issue 7, Copyright (C) 2013 by the Institute of Electrical and Electronics Engineers, Inc
       and The Open Group.  (This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) 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.unix.org/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 .