logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

posix_spawnattr_getschedpolicy.3p (3681B)

    

  1. '\" et
  2. .TH POSIX_SPAWNATTR_GETSCHEDPOLICY "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. posix_spawnattr_getschedpolicy,
  12. posix_spawnattr_setschedpolicy
  13. \(em get and set the spawn-schedpolicy attribute of a spawn attributes object
  14. (\fBADVANCED REALTIME\fP)
  15. .SH SYNOPSIS
  16. .LP
  17. .nf
  18. #include <spawn.h>
  19. #include <sched.h>
  20. .P
  21. int posix_spawnattr_getschedpolicy(const posix_spawnattr_t
  22.     *restrict \fIattr\fP, int *restrict \fIschedpolicy\fP);
  23. int posix_spawnattr_setschedpolicy(posix_spawnattr_t *\fIattr\fP,
  24.     int \fIschedpolicy\fP);
  25. .fi
  26. .SH DESCRIPTION
  27. The
  28. \fIposix_spawnattr_getschedpolicy\fR()
  29. function shall obtain the value of the
  30. .IR spawn-schedpolicy
  31. attribute from the attributes object referenced by
  32. .IR attr .
  33. .P
  34. The
  35. \fIposix_spawnattr_setschedpolicy\fR()
  36. function shall set the
  37. .IR spawn-schedpolicy
  38. attribute in an initialized attributes object referenced by
  39. .IR attr .
  40. .P
  41. The
  42. .IR spawn-schedpolicy
  43. attribute represents the scheduling policy to be assigned to the new
  44. process image in a spawn operation (if POSIX_SPAWN_SETSCHEDULER is set
  45. in the
  46. .IR spawn-flags
  47. attribute). The default value of this attribute is unspecified.
  48. .SH "RETURN VALUE"
  49. Upon successful completion,
  50. \fIposix_spawnattr_getschedpolicy\fR()
  51. shall return zero and store the value of the
  52. .IR spawn-schedpolicy
  53. attribute of
  54. .IR attr
  55. into the object referenced by the
  56. .IR schedpolicy
  57. parameter; otherwise, an error number shall be returned to indicate the
  58. error.
  59. .P
  60. Upon successful completion,
  61. \fIposix_spawnattr_setschedpolicy\fR()
  62. shall return zero; otherwise, an error number shall be returned to
  63. indicate the error.
  64. .SH ERRORS
  65. These functions may fail if:
  66. .TP
  67. .BR EINVAL
  68. The value specified by
  69. .IR attr
  70. is invalid.
  71. .P
  72. The
  73. \fIposix_spawnattr_setschedpolicy\fR()
  74. function may fail if:
  75. .TP
  76. .BR EINVAL
  77. The value of the attribute being set is not valid.
  78. .LP
  79. .IR "The following sections are informative."
  80. .SH EXAMPLES
  81. None.
  82. .SH "APPLICATION USAGE"
  83. These functions are part of the Spawn and Process Scheduling options
  84. and need not be provided on all implementations.
  85. .SH RATIONALE
  86. None.
  87. .SH "FUTURE DIRECTIONS"
  88. None.
  89. .SH "SEE ALSO"
  90. .ad l
  91. .IR "\fIposix_spawn\fR\^(\|)",
  92. .IR "\fIposix_spawnattr_destroy\fR\^(\|)",
  93. .IR "\fIposix_spawnattr_getsigdefault\fR\^(\|)",
  94. .IR "\fIposix_spawnattr_getflags\fR\^(\|)",
  95. .IR "\fIposix_spawnattr_getpgroup\fR\^(\|)",
  96. .IR "\fIposix_spawnattr_getschedparam\fR\^(\|)",
  97. .IR "\fIposix_spawnattr_getsigmask\fR\^(\|)"
  98. .ad b
  99. .P
  100. The Base Definitions volume of POSIX.1\(hy2017,
  101. .IR "\fB<sched.h>\fP",
  102. .IR "\fB<spawn.h>\fP"
  103. .\"
  104. .SH COPYRIGHT
  105. Portions of this text are reprinted and reproduced in electronic form
  106. from IEEE Std 1003.1-2017, Standard for Information Technology
  107. -- Portable Operating System Interface (POSIX), The Open Group Base
  108. Specifications Issue 7, 2018 Edition,
  109. Copyright (C) 2018 by the Institute of
  110. Electrical and Electronics Engineers, Inc and The Open Group.
  111. In the event of any discrepancy between this version and the original IEEE and
  112. The Open Group Standard, the original IEEE and The Open Group Standard
  113. is the referee document. The original Standard can be obtained online at
  114. http://www.opengroup.org/unix/online.html .
  115. .PP
  116. Any typographical or formatting errors that appear
  117. in this page are most likely
  118. to have been introduced during the conversion of the source files to
  119. man page format. To report such errors, see
  120. https://www.kernel.org/doc/man-pages/reporting_bugs.html .