From f7787f8cc26b211f68dda3180a112ba3074ca638 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 31 Mar 2024 10:16:46 -0700 Subject: nng_socket_pair --- docs/man/nng_socket_pair.3supp.adoc | 53 ------------------------------------- 1 file changed, 53 deletions(-) delete mode 100644 docs/man/nng_socket_pair.3supp.adoc (limited to 'docs/man') 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. -// -// 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 -#include - -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)] -- cgit v1.2.3-70-g09d2