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_getschedparam.3p (3752B)

    

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