summaryrefslogtreecommitdiff
path: root/static/freebsd/man3/pthread_mutex_consistent.3 3.html
diff options
context:
space:
mode:
Diffstat (limited to 'static/freebsd/man3/pthread_mutex_consistent.3 3.html')
-rw-r--r--static/freebsd/man3/pthread_mutex_consistent.3 3.html88
1 files changed, 88 insertions, 0 deletions
diff --git a/static/freebsd/man3/pthread_mutex_consistent.3 3.html b/static/freebsd/man3/pthread_mutex_consistent.3 3.html
new file mode 100644
index 00000000..2ce46974
--- /dev/null
+++ b/static/freebsd/man3/pthread_mutex_consistent.3 3.html
@@ -0,0 +1,88 @@
+<table class="head">
+ <tr>
+ <td class="head-ltitle">PTHREAD_MUTEX_CONSISTENT(3)</td>
+ <td class="head-vol">Library Functions Manual</td>
+ <td class="head-rtitle">PTHREAD_MUTEX_CONSISTENT(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_mutex_consistent</code> &#x2014;
+ <span class="Nd">mark state protected by robust mutex as
+ consistent</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_mutex_consistent</code>(<var class="Fa" style="white-space: nowrap;">pthread_mutex_t
+ *mutex</var>);</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
+<p class="Pp">If the process containing the thread owning a robust mutex
+ terminates while holding the mutex, the mutex becomes inconsistent and the
+ next thread that acquires the mutex lock is notified of the state by the
+ return value <code class="Er">EOWNERDEAD</code>. In this case, the mutex
+ does not become normally usable again until the state is marked
+ consistent.</p>
+<p class="Pp" id="pthread_mutex_consistent">The
+ <a class="permalink" href="#pthread_mutex_consistent"><code class="Fn">pthread_mutex_consistent</code></a>(),
+ when called with the <var class="Fa">mutex</var> argument, which points to
+ the initialized robust mutex in an inconsistent state, marks the by mutex as
+ consistent again. The consequent unlock of the mutex, by either
+ <a class="permalink" href="#pthread_mutex_unlock"><code class="Fn" id="pthread_mutex_unlock">pthread_mutex_unlock</code></a>()
+ or other methods, allows other contenders to lock the mutex.</p>
+<p class="Pp" id="pthread_mutex_consistent~2">If the mutex in the inconsistent
+ state is not marked consistent by the call to
+ <a class="permalink" href="#pthread_mutex_consistent~2"><code class="Fn">pthread_mutex_consistent</code></a>()
+ before unlock, further attempts to lock the <var class="Fa">mutex</var>
+ result in the <code class="Er">ENOTRECOVERABLE</code> condition reported by
+ the locking functions.</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, <code class="Fn">pthread_mutex_consistent</code>()
+ will return zero, otherwise an error number will be 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_mutex_lock</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 mutex pointed to by the <var class="Fa">mutex</var> argument is not
+ robust, or is not in the inconsistent state.</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_mutex_init(3)</a>,
+ <a class="Xr">pthread_mutex_lock(3)</a>,
+ <a class="Xr">pthread_mutex_unlock(3)</a>,
+ <a class="Xr">pthread_mutexattr_setrobust(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_mutex_lock</code>() function conforms
+ to <span class="St">Version&#x00A0;4 of the Single UNIX Specification
+ (&#x201C;SUSv4&#x201D;)</span>.</p>
+</section>
+</div>
+<table class="foot">
+ <tr>
+ <td class="foot-date">March 27, 2017</td>
+ <td class="foot-os">FreeBSD 15.0</td>
+ </tr>
+</table>