diff options
Diffstat (limited to 'static/freebsd/man3/pthread_condattr.3 3.html')
| -rw-r--r-- | static/freebsd/man3/pthread_condattr.3 3.html | 154 |
1 files changed, 0 insertions, 154 deletions
diff --git a/static/freebsd/man3/pthread_condattr.3 3.html b/static/freebsd/man3/pthread_condattr.3 3.html deleted file mode 100644 index 2cbb12b1..00000000 --- a/static/freebsd/man3/pthread_condattr.3 3.html +++ /dev/null @@ -1,154 +0,0 @@ -<table class="head"> - <tr> - <td class="head-ltitle">PTHREAD_CONDATTR(3)</td> - <td class="head-vol">Library Functions Manual</td> - <td class="head-rtitle">PTHREAD_CONDATTR(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_condattr_init</code>, - <code class="Nm">pthread_condattr_destroy</code>, - <code class="Nm">pthread_condattr_getclock</code>, - <code class="Nm">pthread_condattr_setclock</code>, - <code class="Nm">pthread_condattr_getpshared</code>, - <code class="Nm">pthread_condattr_setpshared</code> — - <span class="Nd">condition 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_condattr_init</code>(<var class="Fa" style="white-space: nowrap;">pthread_condattr_t - *attr</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">pthread_condattr_destroy</code>(<var class="Fa" style="white-space: nowrap;">pthread_condattr_t - *attr</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">pthread_condattr_getclock</code>(<var class="Fa">pthread_condattr_t - * restrict attr</var>, <var class="Fa">clockid_t * restrict - clock_id</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">pthread_condattr_setclock</code>(<var class="Fa" style="white-space: nowrap;">pthread_condattr_t - *attr</var>, <var class="Fa" style="white-space: nowrap;">clockid_t - clock_id</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">pthread_condattr_getpshared</code>(<var class="Fa">pthread_condattr_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_condattr_setpshared</code>(<var class="Fa" style="white-space: nowrap;">pthread_condattr_t - *attr</var>, <var class="Fa" style="white-space: nowrap;">int - pshared</var>);</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> -<p class="Pp">Condition attribute objects are used to specify parameters to - <a class="permalink" href="#pthread_cond_init"><code class="Fn" id="pthread_cond_init">pthread_cond_init</code></a>().</p> -<p class="Pp" id="pthread_condattr_init">The - <a class="permalink" href="#pthread_condattr_init"><code class="Fn">pthread_condattr_init</code></a>() - function initializes a condition attribute object with the default - attributes.</p> -<p class="Pp" id="pthread_condattr_destroy">The - <a class="permalink" href="#pthread_condattr_destroy"><code class="Fn">pthread_condattr_destroy</code></a>() - function destroys a condition attribute object.</p> -<p class="Pp" id="pthread_condattr_getclock">The - <a class="permalink" href="#pthread_condattr_getclock"><code class="Fn">pthread_condattr_getclock</code></a>() - function will put the value of the clock attribute from - <var class="Fa">attr</var> into the memory area pointed to by - <var class="Fa">clock_id</var>. The - <a class="permalink" href="#pthread_condattr_setclock"><code class="Fn" id="pthread_condattr_setclock">pthread_condattr_setclock</code></a>() - function will set the clock attribute of <var class="Fa">attr</var> to the - value specified in <var class="Fa">clock_id</var>. The clock attribute - affects the interpretation of <var class="Fa">abstime</var> in - <a class="Xr">pthread_cond_timedwait(3)</a> and may be set to - <code class="Dv">CLOCK_REALTIME</code> (default), - <code class="Dv">CLOCK_TAI</code>, or - <code class="Dv">CLOCK_MONOTONIC</code>.</p> -<p class="Pp" id="pthread_condattr_getpshared">The - <a class="permalink" href="#pthread_condattr_getpshared"><code class="Fn">pthread_condattr_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_condattr_setpshared"><code class="Fn" id="pthread_condattr_setpshared">pthread_condattr_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 condition variable 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 condition variable it is attached to may be accessed by threads in - processes other than the one that created the object.</dd> -</dl> -See <a class="Xr">libthr(3)</a> for details of the implementation of shared - condition variables, and their limitations. -</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_condattr_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_condattr_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_condattr_setclock</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">clock_id</var> is not one of the - allowed values.</dd> -</dl> -<p class="Pp">The <code class="Fn">pthread_condattr_setpshared</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>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">libthr(3)</a>, - <a class="Xr">pthread_cond_init(3)</a>, - <a class="Xr">pthread_cond_timedwait(3)</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_condattr_init</code>() and - <code class="Fn">pthread_condattr_destroy</code>() functions conform to - <span class="St">ISO/IEC 9945-1:1996 (“POSIX.1”)</span></p> -</section> -</div> -<table class="foot"> - <tr> - <td class="foot-date">October 27, 2023</td> - <td class="foot-os">FreeBSD 15.0</td> - </tr> -</table> |
