diff options
Diffstat (limited to 'docs/ref/api/util')
| -rw-r--r-- | docs/ref/api/util/nng_random.md | 25 | ||||
| -rw-r--r-- | docs/ref/api/util/nng_socket_pair.md | 42 | ||||
| -rw-r--r-- | docs/ref/api/util/nng_version.md | 36 |
3 files changed, 0 insertions, 103 deletions
diff --git a/docs/ref/api/util/nng_random.md b/docs/ref/api/util/nng_random.md deleted file mode 100644 index b8a89d0e..00000000 --- a/docs/ref/api/util/nng_random.md +++ /dev/null @@ -1,25 +0,0 @@ -# nng_random - -## NAME - -nng_random --- get random number - -## SYNOPSIS - -```c -#include <nng/nng.h> - -uint32_t nng_random(void); -``` - -## DESCRIPTION - -The {{i:`nng_random`}} returns a {{i: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. diff --git a/docs/ref/api/util/nng_socket_pair.md b/docs/ref/api/util/nng_socket_pair.md deleted file mode 100644 index 454c15fc..00000000 --- a/docs/ref/api/util/nng_socket_pair.md +++ /dev/null @@ -1,42 +0,0 @@ -# nng_socket_pair - -## NAME - -nng_socket_pair --- create a connected pair of BSD sockets - -## SYNOPSIS - -```c -#include <nng/nng.h> - -int nng_socket_pair(int fds[2]); -``` - -## DESCRIPTION - -The `nng_socket_pair` function creates a pair of connected BSD sockets. -These sockets, which are returned in the _fds_ array, are suitable for -use with the [BSD socket transport][socket]. - -On POSIX platforms, this is a thin wrapper around the standard `socketpair` function, -using the {{i:`AF_UNIX`}} family and the `SOCK_STREAM` socket type. -{{footnote: At present only POSIX platforms implementing `socketpair` support 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. - -## RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -## ERRORS - -- `NNG_ENOMEM`: Insufficient memory exists. -- `NNG_ENOTSUP`: This platform does not support socket pairs. - -## SEE ALSO - -[BSD Socket Transport][socket] - -[socket]: ../../tran/socket.md diff --git a/docs/ref/api/util/nng_version.md b/docs/ref/api/util/nng_version.md deleted file mode 100644 index 04a1dd1b..00000000 --- a/docs/ref/api/util/nng_version.md +++ /dev/null @@ -1,36 +0,0 @@ -# nng_version - -## NAME - -nng_version --- report library version - -## SYNOPSIS - -```c -#include <nng/nng.h> - -const char * nng_version(void); -``` - -## DESCRIPTION - -The {{i:`nng_version`}} function returns a human readable {{i:version number}} -for _NNG_. - -Additionally, compile time version information is available -via some predefined macros: - -- {{i:`NNG_MAJOR_VERSION`}}: Major version number. -- {{i:`NNG_MINOR_VERSION`}}: Minor version number. -- {{i:`NNG_PATCH_VERSION`}}: Patch version number. - -_NNG_ is developed and released using -[Semantic Versioning 2.0](http://www.semver.org), and -the version numbers reported refer to both the API and the library itself. -(The {{i:ABI}} -- {{i:application binary interface}} -- between the -library and the application is controlled in a similar, but different -manner depending upon the link options and how the library is built.) - -## RETURN VALUES - -`NUL`-terminated string containing the library version number. |
