diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-03-25 21:48:58 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-03-25 21:48:58 -0700 |
| commit | 87e5fc287fedb14656f964254f9b5c738c72b72a (patch) | |
| tree | 4bbd8ce889381d7b2de21b3c888a38c87acf7e31 /docs/reference/src/api/util | |
| parent | 9d71bbc9f67478ccc28bf6ea9cb1617e8293be94 (diff) | |
| download | nng-87e5fc287fedb14656f964254f9b5c738c72b72a.tar.gz nng-87e5fc287fedb14656f964254f9b5c738c72b72a.tar.bz2 nng-87e5fc287fedb14656f964254f9b5c738c72b72a.zip | |
More content changes.
Diffstat (limited to 'docs/reference/src/api/util')
| -rw-r--r-- | docs/reference/src/api/util/index.md | 8 | ||||
| -rw-r--r-- | docs/reference/src/api/util/nng_clock.md | 3 | ||||
| -rw-r--r-- | docs/reference/src/api/util/nng_random.md | 39 | ||||
| -rw-r--r-- | docs/reference/src/api/util/nng_strerror.md | 45 | ||||
| -rw-r--r-- | docs/reference/src/api/util/nng_version.md | 4 |
5 files changed, 37 insertions, 62 deletions
diff --git a/docs/reference/src/api/util/index.md b/docs/reference/src/api/util/index.md index a830d6bd..2ca0bc0b 100644 --- a/docs/reference/src/api/util/index.md +++ b/docs/reference/src/api/util/index.md @@ -1 +1,9 @@ # General Purpose Functions + +# See Also + +[nng_alloc()](nng_alloc.md), +[nng_clock()](nng_clock.md), +[nng_free()](nng_free.md), +[nng_random()](nng_random.md), +[nng_version()](nng_version.md) diff --git a/docs/reference/src/api/util/nng_clock.md b/docs/reference/src/api/util/nng_clock.md index 3653bfa2..2b42b158 100644 --- a/docs/reference/src/api/util/nng_clock.md +++ b/docs/reference/src/api/util/nng_clock.md @@ -29,7 +29,8 @@ very fine-grained values. > but different programs may have different references. This function is intended to help with setting appropriate -timeouts using [`nng_cv_until()`](../threads/nng_cv_until.md). +timeouts using [`nng_cv_until()`](../threads/nng_cv_until.md) +or [`nng_aio_set_expire()`](../aio/nng_aio_set_timeout.md). ## RETURN VALUES diff --git a/docs/reference/src/api/util/nng_random.md b/docs/reference/src/api/util/nng_random.md index 3f8ac39e..b358dfb6 100644 --- a/docs/reference/src/api/util/nng_random.md +++ b/docs/reference/src/api/util/nng_random.md @@ -1,45 +1,26 @@ -= nng_random(3supp) -// -// Copyright 2018 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 -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// +# nng_random() -== NAME +## NAME -nng_random - get random number +nng_random --- get random number -== SYNOPSIS +## SYNOPSIS -[source, c] ----- +```c #include <nng/nng.h> #include <nng/supplemental/util/platform.h> uint32_t nng_random(void); ----- +``` -== DESCRIPTION +## 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 +The value is obtained using platform-specific cryptographically strong random number facilities when available. -== RETURN VALUES +## RETURN VALUES -Random number. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:nng.7.adoc[nng(7)] +Returns a random 32-bit value. diff --git a/docs/reference/src/api/util/nng_strerror.md b/docs/reference/src/api/util/nng_strerror.md index 145fd0bc..3315651a 100644 --- a/docs/reference/src/api/util/nng_strerror.md +++ b/docs/reference/src/api/util/nng_strerror.md @@ -1,48 +1,33 @@ -= nng_strerror(3) -// -// Copyright 2018 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 -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// +# nng_strerror() -== NAME +## NAME -nng_strerror - return an error description +nng_strerror --- return an error description -== SYNOPSIS +## SYNOPSIS -[source, c] ----- +```c #include <nng/nng.h> const char * nng_strerror(int err); ----- +``` -== DESCRIPTION +## DESCRIPTION The `nng_strerror()` returns the human-readable description of the given error in `err`. -NOTE: The returned error message is provided in US English, but in the +The returned error message is provided in US English, but in the future locale-specific strings may be presented instead. -NOTE: The specific strings associated with specific error messages are -subject to change. -Therefore applications must not depend on the message, -but may use them verbatim when supplying information to end-users, such -as in diagnostic messages or log entries. +> [!NOTE] +> The specific strings associated with specific error messages are +> subject to change. +> Therefore applications must not depend on the message, +> but may use them verbatim when supplying information to end-users, such +> as in diagnostic messages or log entries. -== RETURN VALUES +## RETURN VALUES This function returns the human-readable error message, terminated by a `NUL` byte. - -== SEE ALSO - -[.text-left] -xref:libnng.3.adoc[libnng(3)], -xref:nng.7.adoc[nng(7)] diff --git a/docs/reference/src/api/util/nng_version.md b/docs/reference/src/api/util/nng_version.md index 7cc10bdf..20ae094b 100644 --- a/docs/reference/src/api/util/nng_version.md +++ b/docs/reference/src/api/util/nng_version.md @@ -2,7 +2,7 @@ ## NAME -nng_version - report library version +nng_version --- report library version ## SYNOPSIS @@ -33,4 +33,4 @@ manner depending upon the link options and how the library is built.) ## RETURN VALUES -Null-terminated string containing the library version number. +`NUL`-terminated string containing the library version number. |
