diff options
Diffstat (limited to 'static/freebsd/man3/pthread_getconcurrency.3 3.html')
| -rw-r--r-- | static/freebsd/man3/pthread_getconcurrency.3 3.html | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/static/freebsd/man3/pthread_getconcurrency.3 3.html b/static/freebsd/man3/pthread_getconcurrency.3 3.html new file mode 100644 index 00000000..c9bbee7f --- /dev/null +++ b/static/freebsd/man3/pthread_getconcurrency.3 3.html @@ -0,0 +1,98 @@ +<table class="head"> + <tr> + <td class="head-ltitle">PTHREAD_GETCONCURRENCY(3)</td> + <td class="head-vol">Library Functions Manual</td> + <td class="head-rtitle">PTHREAD_GETCONCURRENCY(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_getconcurrency</code>, + <code class="Nm">pthread_setconcurrency</code> — <span class="Nd">get + or set level of concurrency</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_getconcurrency</code>(<var class="Fa" style="white-space: nowrap;">void</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_setconcurrency</code>(<var class="Fa" style="white-space: nowrap;">int + new_level</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_setconcurrency"><code class="Fn" id="pthread_setconcurrency">pthread_setconcurrency</code></a>() + function allows an application to inform the threads implementation of its + desired concurrency level, <var class="Fa">new_level</var>. The actual level + of concurrency provided by the implementation as a result of this function + call is unspecified. If <var class="Fa">new_level</var> is zero, it causes + the implementation to maintain the concurrency level at its discretion as if + <code class="Fn">pthread_setconcurrency</code>() was never called. The + <a class="permalink" href="#pthread_getconcurrency"><code class="Fn" id="pthread_getconcurrency">pthread_getconcurrency</code></a>() + function returns the value set by a previous call to the + <code class="Fn">pthread_setconcurrency</code>() function. If the + <code class="Fn">pthread_setconcurrency</code>() function was not previously + called, this function returns zero to indicate that the implementation is + maintaining the concurrency level. When an application calls + <code class="Fn">pthread_setconcurrency</code>(), it is informing the + implementation of its desired concurrency level. The implementation uses + this as a hint, not a requirement.</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, the + <code class="Fn">pthread_setconcurrency</code>() function returns zero. + Otherwise, an error number is returned to indicate the error. The + <code class="Fn">pthread_getconcurrency</code>() function always returns the + concurrency level set by a previous call to + <code class="Fn">pthread_setconcurrency</code>(). If the + <code class="Fn">pthread_setconcurrency</code>() function has never been + called, <code class="Fn">pthread_getconcurrency</code>() returns zero.</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_setconcurrency</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>The value specified by <var class="Fa">new_level</var> is negative.</dd> + <dt id="EAGAIN">[<a class="permalink" href="#EAGAIN"><code class="Er">EAGAIN</code></a>]</dt> + <dd>The value specified by <var class="Fa">new_level</var> would cause a + system resource to be exceeded.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="APPLICATION_USAGE"><a class="permalink" href="#APPLICATION_USAGE">APPLICATION + USAGE</a></h1> +<p class="Pp">Use of these functions changes the state of the underlying + concurrency upon which the application depends. Library developers are + advised to not use the <code class="Fn">pthread_getconcurrency</code>() and + <code class="Fn">pthread_setconcurrency</code>() functions since their use + may conflict with an application's use of these functions.</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_getconcurrency</code>() and + <code class="Fn">pthread_setconcurrency</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">April 11, 2003</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |