summaryrefslogtreecommitdiff
path: root/docs/reference/src/util/nng_random.md
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-03-30 16:12:02 -0700
committerGarrett D'Amore <garrett@damore.org>2024-03-30 16:12:02 -0700
commitb779b71b00c5f5f8cb9f0ee7d8feeadf9e2dca48 (patch)
treea4f70586954a32d8c2fef36c46aa601ee874606e /docs/reference/src/util/nng_random.md
parenta622720b87cbee884c07feac228796415d4cb548 (diff)
downloadnng-b779b71b00c5f5f8cb9f0ee7d8feeadf9e2dca48.tar.gz
nng-b779b71b00c5f5f8cb9f0ee7d8feeadf9e2dca48.tar.bz2
nng-b779b71b00c5f5f8cb9f0ee7d8feeadf9e2dca48.zip
util funcs reorg
Diffstat (limited to 'docs/reference/src/util/nng_random.md')
-rw-r--r--docs/reference/src/util/nng_random.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/reference/src/util/nng_random.md b/docs/reference/src/util/nng_random.md
new file mode 100644
index 00000000..e4f6f52a
--- /dev/null
+++ b/docs/reference/src/util/nng_random.md
@@ -0,0 +1,28 @@
+# nng_random
+
+## NAME
+
+nng_random --- get random number
+
+## SYNOPSIS
+
+```c
+#include <nng/nng.h>
+#include <nng/supplemental/util/platform.h>
+
+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.
+
+## RETURN VALUES
+
+Returns a random 32-bit value.
+
+{{#include ../refs.md}}