aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/man/nng_cv_alloc.3supp.adoc3
-rw-r--r--docs/man/nng_cv_free.3supp.adoc3
-rw-r--r--docs/man/nng_cv_until.3supp.adoc3
-rw-r--r--docs/man/nng_cv_wait.3supp.adoc3
-rw-r--r--docs/man/nng_cv_wake.3supp.adoc3
-rw-r--r--docs/man/nng_cv_wake1.3supp.adoc3
-rw-r--r--docs/man/nng_mtx_alloc.3supp.adoc3
-rw-r--r--docs/man/nng_mtx_free.3supp.adoc3
-rw-r--r--docs/man/nng_mtx_lock.3supp.adoc12
-rw-r--r--docs/man/nng_mtx_unlock.3supp.adoc3
-rw-r--r--docs/man/nng_thread_create.3supp.adoc3
-rw-r--r--docs/man/nng_thread_destroy.3supp.adoc3
-rw-r--r--docs/man/nng_thread_set_name.3supp.adoc3
13 files changed, 13 insertions, 35 deletions
diff --git a/docs/man/nng_cv_alloc.3supp.adoc b/docs/man/nng_cv_alloc.3supp.adoc
index 9e58e3f1..f87f70f8 100644
--- a/docs/man/nng_cv_alloc.3supp.adoc
+++ b/docs/man/nng_cv_alloc.3supp.adoc
@@ -1,6 +1,6 @@
= nng_cv_alloc(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_cv_alloc - allocate condition variable
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
typedef struct nng_cv nng_cv;
diff --git a/docs/man/nng_cv_free.3supp.adoc b/docs/man/nng_cv_free.3supp.adoc
index 0610b52f..82eeb033 100644
--- a/docs/man/nng_cv_free.3supp.adoc
+++ b/docs/man/nng_cv_free.3supp.adoc
@@ -1,6 +1,6 @@
= nng_cv_free(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_cv_free - free condition variable
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
void nng_cv_free(nng_cv *cv);
----
diff --git a/docs/man/nng_cv_until.3supp.adoc b/docs/man/nng_cv_until.3supp.adoc
index 9cf7c714..a168599d 100644
--- a/docs/man/nng_cv_until.3supp.adoc
+++ b/docs/man/nng_cv_until.3supp.adoc
@@ -1,6 +1,6 @@
= nng_cv_until(3supp)
//
-// Copyright 2021 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_cv_until - wait for condition or timeout
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
int nng_cv_until(nng_cv *cv, nng_time when);
----
diff --git a/docs/man/nng_cv_wait.3supp.adoc b/docs/man/nng_cv_wait.3supp.adoc
index 1d9c16be..9078ac44 100644
--- a/docs/man/nng_cv_wait.3supp.adoc
+++ b/docs/man/nng_cv_wait.3supp.adoc
@@ -1,6 +1,6 @@
= nng_cv_wait(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_cv_wait - wait for condition
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
void nng_cv_wait(nng_cv *cv);
----
diff --git a/docs/man/nng_cv_wake.3supp.adoc b/docs/man/nng_cv_wake.3supp.adoc
index 6ee2945d..a4fe2eca 100644
--- a/docs/man/nng_cv_wake.3supp.adoc
+++ b/docs/man/nng_cv_wake.3supp.adoc
@@ -1,6 +1,6 @@
= nng_cv_wake(3supp)
//
-// Copyright 2020 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_cv_wake - wake all waiters
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
void nng_cv_wake(nng_cv *cv);
----
diff --git a/docs/man/nng_cv_wake1.3supp.adoc b/docs/man/nng_cv_wake1.3supp.adoc
index 4f8b8326..de556698 100644
--- a/docs/man/nng_cv_wake1.3supp.adoc
+++ b/docs/man/nng_cv_wake1.3supp.adoc
@@ -1,6 +1,6 @@
= nng_cv_wake1(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_cv_wake1 - wake one waiter
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
void nng_cv_wake1(nng_cv *cv);
----
diff --git a/docs/man/nng_mtx_alloc.3supp.adoc b/docs/man/nng_mtx_alloc.3supp.adoc
index 45bbfac2..68ce691b 100644
--- a/docs/man/nng_mtx_alloc.3supp.adoc
+++ b/docs/man/nng_mtx_alloc.3supp.adoc
@@ -1,6 +1,6 @@
= nng_mtx_alloc(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_alloc - allocate mutex
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
typedef struct nng_mtx nng_mtx;
diff --git a/docs/man/nng_mtx_free.3supp.adoc b/docs/man/nng_mtx_free.3supp.adoc
index 2867afe1..f247cbf9 100644
--- a/docs/man/nng_mtx_free.3supp.adoc
+++ b/docs/man/nng_mtx_free.3supp.adoc
@@ -1,6 +1,6 @@
= nng_mtx_free(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_free - free mutex
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
void nng_mtx_free(nng_mtx *mtx);
----
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.
diff --git a/docs/man/nng_mtx_unlock.3supp.adoc b/docs/man/nng_mtx_unlock.3supp.adoc
index d1b048e6..1752fcf7 100644
--- a/docs/man/nng_mtx_unlock.3supp.adoc
+++ b/docs/man/nng_mtx_unlock.3supp.adoc
@@ -1,6 +1,6 @@
= nng_mtx_unlock(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_unlock - unlock mutex
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
void nng_mtx_unlock(nng_mtx *mtx);
----
diff --git a/docs/man/nng_thread_create.3supp.adoc b/docs/man/nng_thread_create.3supp.adoc
index 129bddea..10b02e22 100644
--- a/docs/man/nng_thread_create.3supp.adoc
+++ b/docs/man/nng_thread_create.3supp.adoc
@@ -1,6 +1,6 @@
= nng_thread_create(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_thread_create - create thread
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
typedef struct nng_thread nng_thread;
diff --git a/docs/man/nng_thread_destroy.3supp.adoc b/docs/man/nng_thread_destroy.3supp.adoc
index 95eed813..7caa1cd3 100644
--- a/docs/man/nng_thread_destroy.3supp.adoc
+++ b/docs/man/nng_thread_destroy.3supp.adoc
@@ -1,6 +1,6 @@
= nng_thread_destroy(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_thread_destroy - reap thread
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
void nng_thread_destroy(nng_thread *thread);
----
diff --git a/docs/man/nng_thread_set_name.3supp.adoc b/docs/man/nng_thread_set_name.3supp.adoc
index 36dd8267..fb54fb02 100644
--- a/docs/man/nng_thread_set_name.3supp.adoc
+++ b/docs/man/nng_thread_set_name.3supp.adoc
@@ -1,6 +1,6 @@
= nng_thread_set_name(3supp)
//
-// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech>
+// Copyright 2024 Staysail Systems, Inc. <info@staysail.tech>
//
// This document is supplied under the terms of the MIT License, a
// copy of which should be located in the distribution where this
@@ -17,7 +17,6 @@ nng_thread_set_name - set thread name
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
void nng_thread_set_name(nng_thread *thread, const char *name);
----
generated by cgit v1.2.3-70-g09d2 (git 2.46.0) at 2026-01-18 16:44:50 +0000