aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_socket_pair.3supp.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-04-23 07:14:25 -0700
committerGarrett D'Amore <garrett@damore.org>2024-04-23 07:16:58 -0700
commitff00eac2401732e9efb6170ffb90100dcf6332a7 (patch)
treeedbef35bb4259a95f3624b88611d8daa0dcc2442 /docs/man/nng_socket_pair.3supp.adoc
parent29b73962b939a6fbbf6ea8d5d7680bb06d0eeb99 (diff)
downloadnng-ff00eac2401732e9efb6170ffb90100dcf6332a7.tar.gz
nng-ff00eac2401732e9efb6170ffb90100dcf6332a7.tar.bz2
nng-ff00eac2401732e9efb6170ffb90100dcf6332a7.zip
Move some supplemental APIs to reduce friction in using them.
The supplemental/util/platform.h is kind of a pain, so we move move the prototypes for commonly used functions out of there, into nng.h proper.
Diffstat (limited to 'docs/man/nng_socket_pair.3supp.adoc')
-rw-r--r--docs/man/nng_socket_pair.3supp.adoc5
1 files changed, 2 insertions, 3 deletions
diff --git a/docs/man/nng_socket_pair.3supp.adoc b/docs/man/nng_socket_pair.3supp.adoc
index 68b4a943..7718e27b 100644
--- a/docs/man/nng_socket_pair.3supp.adoc
+++ b/docs/man/nng_socket_pair.3supp.adoc
@@ -1,6 +1,6 @@
= nng_socket_pair(3supp)
//
-// Copyright 2023 Staysail Systems, Inc. <info@staysail.tech>
+// Copyright 2024 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
@@ -17,7 +17,6 @@ nng_socket_pair - create a connected pair of BSD sockets
[source, c]
----
#include <nng/nng.h>
-#include <nng/supplemental/util/platform.h>
int nng_socket_pair(int fds[2]);
----
@@ -34,7 +33,7 @@ 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.
+a child process on UNIX platforms, without requiring a shared filesystem or TCP connection.
== RETURN VALUES