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

sched_yield.3p (2365B)

    

  1. '\" et
  2. .TH SCHED_YIELD "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. sched_yield
  12. \(em yield the processor
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <sched.h>
  17. .P
  18. int sched_yield(void);
  19. .fi
  20. .SH DESCRIPTION
  21. The
  22. \fIsched_yield\fR()
  23. function shall force the running thread to relinquish the processor
  24. until it again becomes the head of its thread list. It takes no arguments.
  25. .SH "RETURN VALUE"
  26. The
  27. \fIsched_yield\fR()
  28. function shall return 0 if it completes successfully; otherwise, it
  29. shall return a value of \-1 and set
  30. .IR errno
  31. to indicate the error.
  32. .SH ERRORS
  33. No errors are defined.
  34. .LP
  35. .IR "The following sections are informative."
  36. .SH EXAMPLES
  37. None.
  38. .SH "APPLICATION USAGE"
  39. The conceptual model for scheduling semantics in POSIX.1\(hy2008 defines
  40. a set of thread lists. This set of thread lists is always present
  41. regardless of the scheduling options supported by the system. On a
  42. system where the Process Scheduling option is not supported, portable
  43. applications should not make any assumptions regarding whether threads
  44. from other processes will be on the same thread list.
  45. .SH RATIONALE
  46. None.
  47. .SH "FUTURE DIRECTIONS"
  48. None.
  49. .SH "SEE ALSO"
  50. The Base Definitions volume of POSIX.1\(hy2017,
  51. .IR "\fB<sched.h>\fP"
  52. .\"
  53. .SH COPYRIGHT
  54. Portions of this text are reprinted and reproduced in electronic form
  55. from IEEE Std 1003.1-2017, Standard for Information Technology
  56. -- Portable Operating System Interface (POSIX), The Open Group Base
  57. Specifications Issue 7, 2018 Edition,
  58. Copyright (C) 2018 by the Institute of
  59. Electrical and Electronics Engineers, Inc and The Open Group.
  60. In the event of any discrepancy between this version and the original IEEE and
  61. The Open Group Standard, the original IEEE and The Open Group Standard
  62. is the referee document. The original Standard can be obtained online at
  63. http://www.opengroup.org/unix/online.html .
  64. .PP
  65. Any typographical or formatting errors that appear
  66. in this page are most likely
  67. to have been introduced during the conversion of the source files to
  68. man page format. To report such errors, see
  69. https://www.kernel.org/doc/man-pages/reporting_bugs.html .