diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-22 15:22:54 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-22 15:22:54 -0700 |
| commit | cc2486615d7585b348b46170a6bb19c8084d6c5b (patch) | |
| tree | 2808f2b010f3931cf40d880d62d5d5293ee9129d /docs/ref/api/util/nng_socket_pair.md | |
| parent | 018294242819ed59e708e23cf40b822e843ec3ac (diff) | |
| download | nng-cc2486615d7585b348b46170a6bb19c8084d6c5b.tar.gz nng-cc2486615d7585b348b46170a6bb19c8084d6c5b.tar.bz2 nng-cc2486615d7585b348b46170a6bb19c8084d6c5b.zip | |
docs: consolidate misc chapter
Diffstat (limited to 'docs/ref/api/util/nng_socket_pair.md')
| -rw-r--r-- | docs/ref/api/util/nng_socket_pair.md | 42 |
1 files changed, 0 insertions, 42 deletions
diff --git a/docs/ref/api/util/nng_socket_pair.md b/docs/ref/api/util/nng_socket_pair.md deleted file mode 100644 index 454c15fc..00000000 --- a/docs/ref/api/util/nng_socket_pair.md +++ /dev/null @@ -1,42 +0,0 @@ -# nng_socket_pair - -## NAME - -nng_socket_pair --- create a connected pair of BSD sockets - -## SYNOPSIS - -```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 [BSD socket transport][socket]. - -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. -{{footnote: 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][socket] - -[socket]: ../../tran/socket.md |
