diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-11 22:32:04 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-11 22:32:04 -0700 |
| commit | cb7c44c30278bf6b93944b9294c07566697406f0 (patch) | |
| tree | 4fe69bf28c01eb0ec5b0ed1ba511d37a3b4dd7ee /docs/man | |
| parent | d82509e810aea45454f9b3692c5577bd86cd65c7 (diff) | |
| download | nng-cb7c44c30278bf6b93944b9294c07566697406f0.tar.gz nng-cb7c44c30278bf6b93944b9294c07566697406f0.tar.bz2 nng-cb7c44c30278bf6b93944b9294c07566697406f0.zip | |
Convert nng_socket_pair.
Also some cleanups on the organization of the mdbook.
Diffstat (limited to 'docs/man')
| -rw-r--r-- | docs/man/libnng.3.adoc | 2 | ||||
| -rw-r--r-- | docs/man/nng_socket_pair.3supp.adoc | 52 |
2 files changed, 1 insertions, 53 deletions
diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc index b787c7e8..5748546d 100644 --- a/docs/man/libnng.3.adoc +++ b/docs/man/libnng.3.adoc @@ -297,7 +297,7 @@ as a convenience to aid in creating portable applications. // |xref:nng_mtx_unlock.3supp.adoc[nng_mtx_unlock()]|unlock mutex |xref:nng_opts_parse.3supp.adoc[nng_opts_parse()]|parse command line options // |xref:nng_random.3supp.adoc[nng_random()]|get random number -|xref:nng_socket_pair.3supp.adoc[nng_socket_pair()]|create connected pair of BSD sockets +// |xref:nng_socket_pair.3supp.adoc[nng_socket_pair()]|create connected pair of BSD sockets |xref:nng_thread_create.3supp.adoc[nng_thread_create()]|create thread |xref:nng_thread_destroy.3supp.adoc[nng_thread_destroy()]|reap thread |xref:nng_thread_set_name.3supp.adoc[nng_thread_set_name()]|set thread name diff --git a/docs/man/nng_socket_pair.3supp.adoc b/docs/man/nng_socket_pair.3supp.adoc deleted file mode 100644 index 7718e27b..00000000 --- a/docs/man/nng_socket_pair.3supp.adoc +++ /dev/null @@ -1,52 +0,0 @@ -= nng_socket_pair(3supp) -// -// 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 -// 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> - -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 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)] |
