diff options
Diffstat (limited to 'static/freebsd/man3/pthread_barrierattr.3 3.html')
| -rw-r--r-- | static/freebsd/man3/pthread_barrierattr.3 3.html | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/static/freebsd/man3/pthread_barrierattr.3 3.html b/static/freebsd/man3/pthread_barrierattr.3 3.html new file mode 100644 index 00000000..9c433bc6 --- /dev/null +++ b/static/freebsd/man3/pthread_barrierattr.3 3.html @@ -0,0 +1,126 @@ +<table class="head"> + <tr> + <td class="head-ltitle">PTHREAD_BARRIERATTR(3)</td> + <td class="head-vol">Library Functions Manual</td> + <td class="head-rtitle">PTHREAD_BARRIERATTR(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_barrierattr_destroy</code>, + <code class="Nm">pthread_barrierattr_getpshared</code>, + <code class="Nm">pthread_barrierattr_init</code>, + <code class="Nm">pthread_barrierattr_setpshared</code> — + <span class="Nd">manipulate a barrier attribute object</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_barrierattr_destroy</code>(<var class="Fa" style="white-space: nowrap;">pthread_barrierattr_t + *attr</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_barrierattr_getpshared</code>(<var class="Fa">const + pthread_barrierattr_t *restrict attr</var>, <var class="Fa">int *restrict + pshared</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_barrierattr_init</code>(<var class="Fa" style="white-space: nowrap;">pthread_barrierattr_t + *attr</var>);</p> +<p class="Pp"><var class="Ft">int</var> + <br/> + <code class="Fn">pthread_barrierattr_setpshared</code>(<var class="Fa">pthread_barrierattr_t + *attr</var>, <var class="Fa">int pshared</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_barrierattr_init"><code class="Fn" id="pthread_barrierattr_init">pthread_barrierattr_init</code></a>() + function will initialize <var class="Fa">attr</var> with default attributes. + The + <a class="permalink" href="#pthread_barrierattr_destroy"><code class="Fn" id="pthread_barrierattr_destroy">pthread_barrierattr_destroy</code></a>() + function will destroy <var class="Fa">attr</var> and release any resources + that may have been allocated on its behalf.</p> +<p class="Pp" id="pthread_barrierattr_getpshared">The + <a class="permalink" href="#pthread_barrierattr_getpshared"><code class="Fn">pthread_barrierattr_getpshared</code></a>() + function will put the value of the process-shared attribute from + <var class="Fa">attr</var> into the memory area pointed to by + <var class="Fa">pshared</var>. The + <a class="permalink" href="#pthread_barrierattr_setpshared"><code class="Fn" id="pthread_barrierattr_setpshared">pthread_barrierattr_setpshared</code></a>() + function will set the process-shared attribute of <var class="Fa">attr</var> + to the value specified in <var class="Fa">pshared</var>. The argument + <var class="Fa">pshared</var> may have one of the following values:</p> +<dl class="Bl-tag"> + <dt id="PTHREAD_PROCESS_PRIVATE"><a class="permalink" href="#PTHREAD_PROCESS_PRIVATE"><code class="Dv">PTHREAD_PROCESS_PRIVATE</code></a></dt> + <dd>The barrier object it is attached to may only be accessed by threads in + the same process as the one that created the object.</dd> + <dt id="PTHREAD_PROCESS_SHARED"><a class="permalink" href="#PTHREAD_PROCESS_SHARED"><code class="Dv">PTHREAD_PROCESS_SHARED</code></a></dt> + <dd>The barrier object it is attached to may be accessed by threads in + processes other than the one that created the object.</dd> +</dl> +</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, all these functions will return zero. Otherwise, an + error number will be returned to indicate the error.</p> +<p class="Pp">None of these functions will return + <code class="Er">EINTR</code>.</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_barrierattr_destroy</code>(), + <code class="Fn">pthread_barrierattr_getpshared</code>() and + <code class="Fn">pthread_barrierattr_setpshared</code>() functions may 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">attr</var> is invalid.</dd> +</dl> +<p class="Pp">The <code class="Fn">pthread_barrierattr_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>Insufficient memory to initialize the barrier attribute object + <var class="Fa">attr</var>.</dd> +</dl> +<p class="Pp">The <code class="Fn">pthread_barrierattr_setpshared</code>() + function 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>The value specified in <var class="Fa">pshared</var> is not one of the + allowed values.</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_barrier_destroy(3)</a>, + <a class="Xr">pthread_barrier_init(3)</a>, + <a class="Xr">pthread_barrier_wait(3)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> +<p class="Pp">The <code class="Fn">pthread_barrierattr_*</code>() functions + first appeared in <span class="Lb">N:M Threading Library (libkse, + -lkse)</span> in <span class="Ux">FreeBSD 5.2</span>, and in + <span class="Lb">1:1 Threading Library (libthr, -lthr)</span> in + <span class="Ux">FreeBSD 5.3</span>. Support for process-shared barriers + appeared in <span class="Ux">FreeBSD 11.0</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> |