From e605ded920a4636e93edbbea31d9625ca5428dfb Mon Sep 17 00:00:00 2001 From: gdamore Date: Wed, 15 Jan 2025 15:03:06 +0000 Subject: deploy: cd9901549239bbe424bc70a48b09f33064d906b6 --- ref/api/misc.html | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'ref/api/misc.html') diff --git a/ref/api/misc.html b/ref/api/misc.html index 2c1aea8f..18e7dc58 100644 --- a/ref/api/misc.html +++ b/ref/api/misc.html @@ -231,13 +231,13 @@ The value returned is suitable for use with cryptographic functions such as key generation, and is obtained using platform-specific cryptographically strong random number facilities when available.

Create Socket Pair

-
int nng_socket_pair(int fds[2]);
+
nng_err nng_socket_pair(int fds[2]);
 
-

The nng_socket_pair function creates a pair of connected file descriptors. +

The nng_socket_pair function creates a pair of connected file descriptors. These file descriptors, which are returned in the fds array, are suitable for use with the Socket transport.

On POSIX platforms, this is a thin wrapper around the standard socketpair function, -using the AF_UNIX family and the SOCK_STREAM socket type. +using the AF_UNIX family and the SOCK_STREAM socket type. 1

This will return zero on success, or an error number. On platforms that lack this capability, such as Windows, it will return NNG_ENOTSUP.

@@ -252,19 +252,19 @@ a child process on UNIX platforms, without requiring the processes use a shared

Report Library Version

const char * nng_version(void);
 
-

The nng_version function returns a human readable version number +

The nng_version function returns a human readable version number for NNG, formatted as a NUL-terminated string.

Additionally, compile time version information is available via some predefined macros:

    -
  • NNG_MAJOR_VERSION: Major version number.
  • -
  • NNG_MINOR_VERSION: Minor version number.
  • -
  • NNG_PATCH_VERSION: Patch version number.
  • +
  • NNG_MAJOR_VERSION: Major version number.
  • +
  • NNG_MINOR_VERSION: Minor version number.
  • +
  • NNG_PATCH_VERSION: Patch version number.

NNG is developed and released using Semantic Versioning 2.0, and the version numbers reported refer to both the API and the library itself. -(The ABI – application binary interface – between the +(The ABI – 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.)

-- cgit v1.2.3-70-g09d2