nng_socket_pair

5 files changed, 48 insertions, 54 deletions

diff --git a/docs/man/nng_socket_pair.3supp.adoc b/docs/man/nng_socket_pair.3supp.adoc
deleted file mode 100644
index 68b4a943..00000000
--- a/docs/man/nng_socket_pair.3supp.adoc
+++ /dev/null
@@ -1,53 +0,0 @@
-= nng_socket_pair(3supp)
-//
-// Copyright 2023 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
-// file was obtained (LICENSE.txt).  A copy of the license may also be
-// found online at https://opensource.org/licenses/MIT.
-//
-
-== NAME
-
-nng_socket_pair - create a connected pair of BSD sockets
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-#include <nng/supplemental/util/platform.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 xref:nng_socket.7.adoc[_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.
-
-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.
-
-== RETURN VALUES
-
-This function returns 0 on success, and non-zero otherwise.
-
-== ERRORS
-
-[horizontal]
-`NNG_ENOMEM`:: Insufficient memory exists.
-`NNG_ENOTSUP`:: This platform does not support socket pairs.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_socket.7.adoc[nng_socket(7)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/reference/src/SUMMARY.md b/docs/reference/src/SUMMARY.md
index 42910b17..40a02f7d 100644
--- a/docs/reference/src/SUMMARY.md
+++ b/docs/reference/src/SUMMARY.md
@@ -115,6 +115,7 @@
     - [nng_msleep](util/nng_msleep.md)
     - [nng_random](util/nng_random.md)
     - [nng_sleep_aio](util/nng_sleep_aio.md)
+    - [nng_socket_pair](util/nng_socket_pair.md)
     - [nng_strdup](util/nng_strdup.md)
     - [nng_strerror](util/nng_strerror.md)
     - [nng_strfree](util/nng_strfree.md)
diff --git a/docs/reference/src/refs.md b/docs/reference/src/refs.md
index 2c7e5028..cb5c74f1 100644
--- a/docs/reference/src/refs.md
+++ b/docs/reference/src/refs.md
@@ -37,6 +37,7 @@
 [ipc]: ../tran/ipc.md
 [tls]: ../tran/tls.md
 [tcp]: ../tran/tcp.md
+[sockfd]: ../tran/socket.md
 
 <!-- Sockets -->
 
@@ -141,6 +142,7 @@
 [nng_msleep]: ../util/nng_msleep.md
 [nng_random]: ../util/nng_random.md
 [nng_sleep_aio]: ../util/nng_sleep_aio.md
+[nng_socket_pair]: ../util/nng_socket_pair.md
 [nng_strdup]: ../util/nng_strdup.md
 [nng_strerror]: ../util/nng_strerror.md
 [nng_strfree]: ../util/nng_strfree.md
diff --git a/docs/reference/src/tran/socket.md b/docs/reference/src/tran/socket.md
index 61de130c..0f6d9bbb 100644
--- a/docs/reference/src/tran/socket.md
+++ b/docs/reference/src/tran/socket.md
@@ -1,4 +1,4 @@
-BSD Socket transport (experimental)
+BSD Socket Transport (Experimental)
 
 The {{i:_socket_ transport}} supports communication between
 peers across arbitrary BSD sockets, such as those that are
diff --git a/docs/reference/src/util/nng_socket_pair.md b/docs/reference/src/util/nng_socket_pair.md
new file mode 100644
index 00000000..ac0fb76a
--- /dev/null
+++ b/docs/reference/src/util/nng_socket_pair.md
@@ -0,0 +1,44 @@
+# nng_socket_pair
+
+## NAME
+
+nng_socket_pair --- create a connected pair of BSD sockets
+
+## SYNOPSIS
+
+```c
+#include <nng/nng.h>
+#include <nng/supplemental/util/platform.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][sockfd] transport.
+
+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.[^1]
+
+[^1]: 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][sockfd]
+
+{{#include ../refs.md}}