diff options
Diffstat (limited to 'static/freebsd/man3/pthread_attr.3 3.html')
| -rw-r--r-- | static/freebsd/man3/pthread_attr.3 3.html | 272 |
1 files changed, 272 insertions, 0 deletions
diff --git a/static/freebsd/man3/pthread_attr.3 3.html b/static/freebsd/man3/pthread_attr.3 3.html new file mode 100644 index 00000000..44ab49e9 --- /dev/null +++ b/static/freebsd/man3/pthread_attr.3 3.html @@ -0,0 +1,272 @@ +<table class="head"> + <tr> + <td class="head-ltitle">PTHREAD_ATTR(3)</td> + <td class="head-vol">Library Functions Manual</td> + <td class="head-rtitle">PTHREAD_ATTR(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_attr_init</code>, + <code class="Nm">pthread_attr_destroy</code>, + <code class="Nm">pthread_attr_setstack</code>, + <code class="Nm">pthread_attr_getstack</code>, + <code class="Nm">pthread_attr_setstacksize</code>, + <code class="Nm">pthread_attr_getstacksize</code>, + <code class="Nm">pthread_attr_setguardsize</code>, + <code class="Nm">pthread_attr_getguardsize</code>, + <code class="Nm">pthread_attr_setstackaddr</code>, + <code class="Nm">pthread_attr_getstackaddr</code>, + <code class="Nm">pthread_attr_setdetachstate</code>, + <code class="Nm">pthread_attr_getdetachstate</code>, + <code class="Nm">pthread_attr_setinheritsched</code>, + <code class="Nm">pthread_attr_getinheritsched</code>, + <code class="Nm">pthread_attr_setschedparam</code>, + <code class="Nm">pthread_attr_getschedparam</code>, + <code class="Nm">pthread_attr_setschedpolicy</code>, + <code class="Nm">pthread_attr_getschedpolicy</code>, + <code class="Nm">pthread_attr_setscope</code>, + <code class="Nm">pthread_attr_getscope</code> — + <span class="Nd">thread attribute operations</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 + <<a class="In">pthread.h</a>></code></p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_init</code>(<var class="Fa" style="white-space: nowrap;">pthread_attr_t + *attr</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_destroy</code>(<var class="Fa" style="white-space: nowrap;">pthread_attr_t + *attr</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_setstack</code>(<var class="Fa" style="white-space: nowrap;">pthread_attr_t + *attr</var>, <var class="Fa" style="white-space: nowrap;"> void + *stackaddr</var>, <var class="Fa" style="white-space: nowrap;">size_t + stacksize</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_getstack</code>(<var class="Fa" style="white-space: nowrap;">const + pthread_attr_t * restrict attr</var>, + <var class="Fa" style="white-space: nowrap;">void ** restrict + stackaddr</var>, <var class="Fa" style="white-space: nowrap;">size_t * + restrict stacksize</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_setstacksize</code>(<var class="Fa" style="white-space: nowrap;">pthread_attr_t + *attr</var>, <var class="Fa" style="white-space: nowrap;">size_t + stacksize</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_getstacksize</code>(<var class="Fa" style="white-space: nowrap;">const + pthread_attr_t *restrict attr</var>, + <var class="Fa" style="white-space: nowrap;">size_t *restrict + stacksize</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_setguardsize</code>(<var class="Fa" style="white-space: nowrap;">pthread_attr_t + *attr</var>, <var class="Fa" style="white-space: nowrap;">size_t + guardsize</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_getguardsize</code>(<var class="Fa" style="white-space: nowrap;">const + pthread_attr_t * restrict attr</var>, + <var class="Fa" style="white-space: nowrap;">size_t * restrict + guardsize</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_setstackaddr</code>(<var class="Fa" style="white-space: nowrap;">pthread_attr_t + *attr</var>, <var class="Fa" style="white-space: nowrap;">void + *stackaddr</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_getstackaddr</code>(<var class="Fa" style="white-space: nowrap;">const + pthread_attr_t *attr</var>, + <var class="Fa" style="white-space: nowrap;">void **stackaddr</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_setdetachstate</code>(<var class="Fa" style="white-space: nowrap;">pthread_attr_t + *attr</var>, <var class="Fa" style="white-space: nowrap;">int + detachstate</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_getdetachstate</code>(<var class="Fa" style="white-space: nowrap;">const + pthread_attr_t *attr</var>, <var class="Fa" style="white-space: nowrap;">int + *detachstate</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_setinheritsched</code>(<var class="Fa" style="white-space: nowrap;">pthread_attr_t + *attr</var>, <var class="Fa" style="white-space: nowrap;">int + inheritsched</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_getinheritsched</code>(<var class="Fa" style="white-space: nowrap;">const + pthread_attr_t *restrict attr</var>, + <var class="Fa" style="white-space: nowrap;">int *restrct + inheritsched</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_setschedparam</code>(<var class="Fa" style="white-space: nowrap;">pthread_attr_t + *attr</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_attr_getschedparam</code>(<var class="Fa" style="white-space: nowrap;">const + pthread_attr_t *attr</var>, + <var class="Fa" style="white-space: nowrap;">struct sched_param + *param</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_setschedpolicy</code>(<var class="Fa" style="white-space: nowrap;">pthread_attr_t + *attr</var>, <var class="Fa" style="white-space: nowrap;">int + policy</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_getschedpolicy</code>(<var class="Fa" style="white-space: nowrap;">const + pthread_attr_t *restrict attr</var>, + <var class="Fa" style="white-space: nowrap;">int *restrict + policy</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_setscope</code>(<var class="Fa" style="white-space: nowrap;">pthread_attr_t + *attr</var>, <var class="Fa" style="white-space: nowrap;">int + contentionscope</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_attr_getscope</code>(<var class="Fa" style="white-space: nowrap;">const + pthread_attr_t *restrict attr</var>, + <var class="Fa" style="white-space: nowrap;">int *restrict + contentionscope</var>);</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">Thread attributes are used to specify parameters to + <a class="permalink" href="#pthread_create"><code class="Fn" id="pthread_create">pthread_create</code></a>(). + One attribute object can be used in multiple calls to + <code class="Fn">pthread_create</code>(), with or without modifications + between calls.</p> +<p class="Pp" id="pthread_attr_init">The + <a class="permalink" href="#pthread_attr_init"><code class="Fn">pthread_attr_init</code></a>() + function initializes <var class="Fa">attr</var> with all the default thread + attributes.</p> +<p class="Pp" id="pthread_attr_destroy">The + <a class="permalink" href="#pthread_attr_destroy"><code class="Fn">pthread_attr_destroy</code></a>() + function destroys <var class="Fa">attr</var>.</p> +<p class="Pp" id="pthread_attr_set*">The + <a class="permalink" href="#pthread_attr_set*"><code class="Fn">pthread_attr_set*</code></a>() + functions set the attribute that corresponds to each function name.</p> +<p class="Pp" id="pthread_attr_get*">The + <a class="permalink" href="#pthread_attr_get*"><code class="Fn">pthread_attr_get*</code></a>() + functions copy the value of the attribute that corresponds to each function + name to the location pointed to by the second function parameter.</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_attr_init</code>() function will fail + if:</p> +<dl class="Bl-tag"> + <dt id="ENOMEM">[<a class="permalink" href="#ENOMEM"><code class="Er">ENOMEM</code></a>]</dt> + <dd>Out of memory.</dd> +</dl> +<p class="Pp">The <code class="Fn">pthread_attr_destroy</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">attr</var>.</dd> +</dl> +<p class="Pp">The <code class="Fn">pthread_attr_setstacksize</code>() and + <code class="Fn">pthread_attr_setstack</code>() functions will fail if:</p> +<dl class="Bl-tag"> + <dt id="EINVAL~2">[<a class="permalink" href="#EINVAL~2"><code class="Er">EINVAL</code></a>]</dt> + <dd><var class="Fa">stacksize</var> is less than + <code class="Dv">PTHREAD_STACK_MIN</code>.</dd> +</dl> +<p class="Pp">The <code class="Fn">pthread_attr_setdetachstate</code>() function + will fail if:</p> +<dl class="Bl-tag"> + <dt id="EINVAL~3">[<a class="permalink" href="#EINVAL~3"><code class="Er">EINVAL</code></a>]</dt> + <dd>Invalid value for <var class="Fa">detachstate</var>.</dd> +</dl> +<p class="Pp">The <code class="Fn">pthread_attr_setinheritsched</code>() + function will fail if:</p> +<dl class="Bl-tag"> + <dt id="EINVAL~4">[<a class="permalink" href="#EINVAL~4"><code class="Er">EINVAL</code></a>]</dt> + <dd>Invalid value for <var class="Fa">attr</var>.</dd> +</dl> +<p class="Pp">The <code class="Fn">pthread_attr_setschedparam</code>() function + will fail if:</p> +<dl class="Bl-tag"> + <dt id="EINVAL~5">[<a class="permalink" href="#EINVAL~5"><code class="Er">EINVAL</code></a>]</dt> + <dd>Invalid value for <var class="Fa">attr</var>.</dd> + <dt id="ENOTSUP">[<a class="permalink" href="#ENOTSUP"><code class="Er">ENOTSUP</code></a>]</dt> + <dd>Invalid value for <var class="Fa">param</var>.</dd> +</dl> +<p class="Pp">The <code class="Fn">pthread_attr_setschedpolicy</code>() function + will fail if:</p> +<dl class="Bl-tag"> + <dt id="EINVAL~6">[<a class="permalink" href="#EINVAL~6"><code class="Er">EINVAL</code></a>]</dt> + <dd>Invalid value for <var class="Fa">attr</var>.</dd> + <dt id="ENOTSUP~2">[<a class="permalink" href="#ENOTSUP~2"><code class="Er">ENOTSUP</code></a>]</dt> + <dd>Invalid or unsupported value for <var class="Fa">policy</var>.</dd> +</dl> +<p class="Pp">The <code class="Fn">pthread_attr_setscope</code>() function will + fail if:</p> +<dl class="Bl-tag"> + <dt id="EINVAL~7">[<a class="permalink" href="#EINVAL~7"><code class="Er">EINVAL</code></a>]</dt> + <dd>Invalid value for <var class="Fa">attr</var>.</dd> + <dt id="ENOTSUP~3">[<a class="permalink" href="#ENOTSUP~3"><code class="Er">ENOTSUP</code></a>]</dt> + <dd>Invalid or unsupported value for + <var class="Fa">contentionscope</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">pthread_attr_affinity_np(3)</a>, + <a class="Xr">pthread_attr_get_np(3)</a>, + <a class="Xr">pthread_create(3)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="STANDARDS"><a class="permalink" href="#STANDARDS">STANDARDS</a></h1> +<p class="Pp"><code class="Fn">pthread_attr_init</code>(), + <code class="Fn">pthread_attr_destroy</code>(), + <code class="Fn">pthread_attr_setstacksize</code>(), + <code class="Fn">pthread_attr_getstacksize</code>(), + <code class="Fn">pthread_attr_setstackaddr</code>(), + <code class="Fn">pthread_attr_getstackaddr</code>(), + <code class="Fn">pthread_attr_setdetachstate</code>(), and + <code class="Fn">pthread_attr_getdetachstate</code>() functions conform to + <span class="St">ISO/IEC 9945-1:1996 (“POSIX.1”)</span></p> +<p class="Pp">The <code class="Fn">pthread_attr_setinheritsched</code>(), + <code class="Fn">pthread_attr_getinheritsched</code>(), + <code class="Fn">pthread_attr_setschedparam</code>(), + <code class="Fn">pthread_attr_getschedparam</code>(), + <code class="Fn">pthread_attr_setschedpolicy</code>(), + <code class="Fn">pthread_attr_getschedpolicy</code>(), + <code class="Fn">pthread_attr_setscope</code>(), and + <code class="Fn">pthread_attr_getscope</code>() functions conform to + <span class="St">Version 2 of the Single UNIX Specification + (“SUSv2”)</span></p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">August 17, 2018</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |