summaryrefslogtreecommitdiff
path: root/static/freebsd/man3/pthread_schedparam.3 3.html
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:43 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:43 -0400
commitac5e55f5f2af5b92794c2aded46c6bae85b5f5ed (patch)
tree9367490586c84cba28652e443e3166d66c33b0d9 /static/freebsd/man3/pthread_schedparam.3 3.html
parent253e67c8b3a72b3a4757fdbc5845297628db0a4a (diff)
docs: Added All FreeBSD Manuals
Diffstat (limited to 'static/freebsd/man3/pthread_schedparam.3 3.html')
-rw-r--r--static/freebsd/man3/pthread_schedparam.3 3.html99
1 files changed, 99 insertions, 0 deletions
diff --git a/static/freebsd/man3/pthread_schedparam.3 3.html b/static/freebsd/man3/pthread_schedparam.3 3.html
new file mode 100644
index 00000000..6413a4f4
--- /dev/null
+++ b/static/freebsd/man3/pthread_schedparam.3 3.html
@@ -0,0 +1,99 @@
+<table class="head">
+ <tr>
+ <td class="head-ltitle">PTHREAD_SCHEDPARAM(3)</td>
+ <td class="head-vol">Library Functions Manual</td>
+ <td class="head-rtitle">PTHREAD_SCHEDPARAM(3)</td>
+ </tr>
+</table>
+<div class="manual-text">
+<section class="Sh">
+<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
+<p class="Pp"><code class="Nm">pthread_setschedparam</code>,
+ <code class="Nm">pthread_getschedparam</code> &#x2014;
+ <span class="Nd">thread scheduling parameter manipulation</span></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="LIBRARY"><a class="permalink" href="#LIBRARY">LIBRARY</a></h1>
+<p class="Pp"><span class="Lb">POSIX Threads Library (libpthread,
+ -lpthread)</span></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
+<p class="Pp"><code class="In">#include
+ &lt;<a class="In">pthread.h</a>&gt;</code></p>
+<p class="Pp"><var class="Ft">int</var>
+ <br/>
+ <code class="Fn">pthread_setschedparam</code>(<var class="Fa" style="white-space: nowrap;">pthread_t
+ thread</var>, <var class="Fa" style="white-space: nowrap;">int policy</var>,
+ <var class="Fa" style="white-space: nowrap;">const struct sched_param
+ *param</var>);</p>
+<p class="Pp"><var class="Ft">int</var>
+ <br/>
+ <code class="Fn">pthread_getschedparam</code>(<var class="Fa" style="white-space: nowrap;">pthread_t
+ thread</var>, <var class="Fa" style="white-space: nowrap;">int *restrict
+ policy</var>, <var class="Fa" style="white-space: nowrap;">struct
+ sched_param *restrict param</var>);</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
+<p class="Pp">The
+ <a class="permalink" href="#pthread_setschedparam"><code class="Fn" id="pthread_setschedparam">pthread_setschedparam</code></a>()
+ and
+ <a class="permalink" href="#pthread_getschedparam"><code class="Fn" id="pthread_getschedparam">pthread_getschedparam</code></a>()
+ functions set and get the scheduling parameters of individual threads. The
+ scheduling policy for a thread can either be
+ <code class="Dv">SCHED_FIFO</code> (first in, first out),
+ <code class="Dv">SCHED_RR</code> (round-robin), or
+ <code class="Dv">SCHED_OTHER</code> (timesharing). Valid thread priorities
+ (accessed via <var class="Va">param-&gt;sched_priority</var>) must be within
+ the range returned by the <a class="Xr">sched_get_priority_min(2)</a> and
+ <a class="Xr">sched_get_priority_max(2)</a> system calls.</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
+ VALUES</a></h1>
+<p class="Pp">If successful, these functions return 0. Otherwise, an error
+ number is returned to indicate the error.</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="ERRORS"><a class="permalink" href="#ERRORS">ERRORS</a></h1>
+<p class="Pp">The <code class="Fn">pthread_setschedparam</code>() function will
+ fail if:</p>
+<dl class="Bl-tag">
+ <dt id="EINVAL">[<a class="permalink" href="#EINVAL"><code class="Er">EINVAL</code></a>]</dt>
+ <dd>Invalid value for <var class="Fa">policy</var>.</dd>
+ <dt id="ENOTSUP">[<a class="permalink" href="#ENOTSUP"><code class="Er">ENOTSUP</code></a>]</dt>
+ <dd>Invalid value for scheduling parameters.</dd>
+ <dt id="EPERM">[<a class="permalink" href="#EPERM"><code class="Er">EPERM</code></a>]</dt>
+ <dd>The calling thread does not have sufficient privilege to perform the
+ operation.</dd>
+ <dt id="ESRCH">[<a class="permalink" href="#ESRCH"><code class="Er">ESRCH</code></a>]</dt>
+ <dd>Non-existent thread <var class="Fa">thread</var>.</dd>
+</dl>
+<p class="Pp">The <code class="Fn">pthread_getschedparam</code>() function will
+ fail if:</p>
+<dl class="Bl-tag">
+ <dt id="ESRCH~2">[<a class="permalink" href="#ESRCH~2"><code class="Er">ESRCH</code></a>]</dt>
+ <dd>Non-existent thread <var class="Fa">thread</var>.</dd>
+</dl>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
+ ALSO</a></h1>
+<p class="Pp"><a class="Xr">sched_get_priority_max(2)</a>,
+ <a class="Xr">sched_get_priority_min(2)</a></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="STANDARDS"><a class="permalink" href="#STANDARDS">STANDARDS</a></h1>
+<p class="Pp">The <code class="Fn">pthread_setschedparam</code>() and
+ <code class="Fn">pthread_getschedparam</code>() functions conform to
+ <span class="St">Version&#x00A0;2 of the Single UNIX Specification
+ (&#x201C;SUSv2&#x201D;)</span>.</p>
+</section>
+</div>
+<table class="foot">
+ <tr>
+ <td class="foot-date">October 17, 2022</td>
+ <td class="foot-os">FreeBSD 15.0</td>
+ </tr>
+</table>