summaryrefslogtreecommitdiff
path: root/static/freebsd/man3/pthread_mutex_trylock.3 3.html
diff options
context:
space:
mode:
Diffstat (limited to 'static/freebsd/man3/pthread_mutex_trylock.3 3.html')
-rw-r--r--static/freebsd/man3/pthread_mutex_trylock.3 3.html83
1 files changed, 83 insertions, 0 deletions
diff --git a/static/freebsd/man3/pthread_mutex_trylock.3 3.html b/static/freebsd/man3/pthread_mutex_trylock.3 3.html
new file mode 100644
index 00000000..938da761
--- /dev/null
+++ b/static/freebsd/man3/pthread_mutex_trylock.3 3.html
@@ -0,0 +1,83 @@
+<table class="head">
+ <tr>
+ <td class="head-ltitle">PTHREAD_MUTEX_TRYLOCK(3)</td>
+ <td class="head-vol">Library Functions Manual</td>
+ <td class="head-rtitle">PTHREAD_MUTEX_TRYLOCK(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_trylock</code> &#x2014;
+ <span class="Nd">attempt to lock a mutex without blocking</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_trylock</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">The
+ <a class="permalink" href="#pthread_mutex_trylock"><code class="Fn" id="pthread_mutex_trylock">pthread_mutex_trylock</code></a>()
+ function locks <var class="Fa">mutex</var>. If the mutex is already locked,
+ <code class="Fn">pthread_mutex_trylock</code>() will not block waiting for
+ the mutex, but will return an error condition.</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_trylock</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_trylock</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">mutex</var> is invalid.</dd>
+ <dt id="EBUSY">[<a class="permalink" href="#EBUSY"><code class="Er">EBUSY</code></a>]</dt>
+ <dd><var class="Fa">Mutex</var> is already locked.</dd>
+ <dt id="EOWNERDEAD">[<a class="permalink" href="#EOWNERDEAD"><code class="Er">EOWNERDEAD</code></a>]</dt>
+ <dd>The argument <var class="Fa">mutex</var> points to a robust mutex and the
+ process containing the previous owning thread terminated while holding the
+ mutex lock. The lock was granted to the caller and it is up to the new
+ owner to make the state consistent.</dd>
+ <dt id="ENOTRECOVERABLE">[<a class="permalink" href="#ENOTRECOVERABLE"><code class="Er">ENOTRECOVERABLE</code></a>]</dt>
+ <dd>The state protected by the <var class="Fa">mutex</var> is not
+ recoverable.</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_consistent(3)</a>,
+ <a class="Xr">pthread_mutex_destroy(3)</a>,
+ <a class="Xr">pthread_mutex_init(3)</a>,
+ <a class="Xr">pthread_mutex_lock(3)</a>,
+ <a class="Xr">pthread_mutex_unlock(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_trylock</code>() function
+ conforms to <span class="St">ISO/IEC 9945-1:1996
+ (&#x201C;POSIX.1&#x201D;)</span>.</p>
+</section>
+</div>
+<table class="foot">
+ <tr>
+ <td class="foot-date">August 7, 2019</td>
+ <td class="foot-os">FreeBSD 15.0</td>
+ </tr>
+</table>