summaryrefslogtreecommitdiff
path: root/docs/man/nng_mtx_lock.3supp.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-04-23 07:39:59 -0700
committerGarrett D'Amore <garrett@damore.org>2024-04-23 07:39:59 -0700
commit01817988f4631bdd8ee5cec9c6b69039712a93fe (patch)
treec8c4259671fbb586a466a8c5d623fc8c183f8927 /docs/man/nng_mtx_lock.3supp.adoc
parentff00eac2401732e9efb6170ffb90100dcf6332a7 (diff)
downloadnng-01817988f4631bdd8ee5cec9c6b69039712a93fe.tar.gz
nng-01817988f4631bdd8ee5cec9c6b69039712a93fe.tar.bz2
nng-01817988f4631bdd8ee5cec9c6b69039712a93fe.zip
Move the rest of the functionality from platform.h into core.
This also deprecates supplemental/util/platform.h.
Diffstat (limited to 'docs/man/nng_mtx_lock.3supp.adoc')
-rw-r--r--docs/man/nng_mtx_lock.3supp.adoc12
1 files changed, 1 insertions, 11 deletions
diff --git a/docs/man/nng_mtx_lock.3supp.adoc b/docs/man/nng_mtx_lock.3supp.adoc
index 91fd2ab5..5f4276fc 100644
--- a/docs/man/nng_mtx_lock.3supp.adoc
+++ b/docs/man/nng_mtx_lock.3supp.adoc
@@ -1,6 +1,6 @@
= nng_mtx_lock(3supp)
//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
+// Copyright 2024 Staysail Systems, Inc. <info@staysail.tech>
// Copyright 2018 Capitar IT Group BV <info@capitar.com>
//
// This document is supplied under the terms of the MIT License, a
@@ -18,7 +18,6 @@ nng_mtx_lock - lock mutex
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
void nng_mtx_lock(nng_mtx *mtx);
----
@@ -39,15 +38,6 @@ same mutex may result in deadlock or aborting the current program.
It is a programming error for the owner of a mutex to attempt to
reacquire it.
-****
-_NNG_ offers neither a non-blocking variant that can fail,
-nor recursive mutexes.
-This is by design, as _NNG_ itself does not use such things,
-and most often the need for them is the result of poor design.
-If such capabilities are needed, they may be synthesized fairly
-easily from mutexes and condition variables.
-****
-
== RETURN VALUES
None.