aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/man/nng_clock.3supp.adoc6
-rw-r--r--docs/man/nng_msleep.3supp.adoc3
-rw-r--r--docs/man/nng_random.3supp.adoc5
-rw-r--r--docs/man/nng_socket_pair.3supp.adoc5
4 files changed, 6 insertions, 13 deletions
diff --git a/docs/man/nng_clock.3supp.adoc b/docs/man/nng_clock.3supp.adoc
index d413f1b2..4c91c645 100644
--- a/docs/man/nng_clock.3supp.adoc
+++ b/docs/man/nng_clock.3supp.adoc
@@ -1,6 +1,6 @@
= nng_clock(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_clock - get time
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
typedef uint64_t nng_time;
@@ -37,8 +36,7 @@ very fine-grained values.
IMPORTANT: The reference time will be the same for a given program,
but different programs may have different references.
-TIP: This function is intended mostly to help with setting appropriate
-timeouts using xref:nng_cv_until.3supp.adoc[`nng_cv_until()`].
+TIP: This function should help with setting appropriate timeouts.
== RETURN VALUES
diff --git a/docs/man/nng_msleep.3supp.adoc b/docs/man/nng_msleep.3supp.adoc
index 57d3615b..bef74587 100644
--- a/docs/man/nng_msleep.3supp.adoc
+++ b/docs/man/nng_msleep.3supp.adoc
@@ -1,6 +1,6 @@
= nng_msleep(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_msleep - sleep milliseconds
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
void nng_msleep(nng_duration msec);
----
diff --git a/docs/man/nng_random.3supp.adoc b/docs/man/nng_random.3supp.adoc
index 3f8ac39e..c2cd4bac 100644
--- a/docs/man/nng_random.3supp.adoc
+++ b/docs/man/nng_random.3supp.adoc
@@ -1,6 +1,6 @@
= nng_random(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_random - get random number
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
uint32_t nng_random(void);
----
@@ -26,8 +25,6 @@ uint32_t nng_random(void);
== DESCRIPTION
The `nng_random()` returns a random number.
-The value returned is suitable for use with cryptographic functions such as
-key generation.
The value is obtained using platform specific cryptographically strong random
number facilities when available.
diff --git a/docs/man/nng_socket_pair.3supp.adoc b/docs/man/nng_socket_pair.3supp.adoc
index 68b4a943..7718e27b 100644
--- a/docs/man/nng_socket_pair.3supp.adoc
+++ b/docs/man/nng_socket_pair.3supp.adoc
@@ -1,6 +1,6 @@
= nng_socket_pair(3supp)
//
-// Copyright 2023 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_socket_pair - create a connected pair of BSD sockets
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
int nng_socket_pair(int fds[2]);
----
@@ -34,7 +33,7 @@ using the `AF_UNIX` family and the `SOCK_STREAM` socket type.
NOTE: At present only POSIX platforms implementing `socketpair()` are supported with this function.
TIP: This function may be useful for creating a shared connection between a parent process and
-a child process on UNIX platforms, without requiring the processes use a shared filesystem or TCP connection.
+a child process on UNIX platforms, without requiring a shared filesystem or TCP connection.
== RETURN VALUES