diff options
| author | Garrett D'Amore <garrett@damore.org> | 2025-01-14 08:26:14 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2025-01-14 08:26:14 -0800 |
| commit | 6dc757342f5f9dedf38de356ae1802546f976bcc (patch) | |
| tree | 87d931b409abcd6f4975c5742592b6d3464f24de /docs/man/nng_pipe_socket.3.adoc | |
| parent | 1b1f4609c6dad724b88dfb069b2260341e582906 (diff) | |
| download | nng-6dc757342f5f9dedf38de356ae1802546f976bcc.tar.gz nng-6dc757342f5f9dedf38de356ae1802546f976bcc.tar.bz2 nng-6dc757342f5f9dedf38de356ae1802546f976bcc.zip | |
docs: pipe documentation
While here addressed some minor issues with http docs as well.
Diffstat (limited to 'docs/man/nng_pipe_socket.3.adoc')
| -rw-r--r-- | docs/man/nng_pipe_socket.3.adoc | 46 |
1 files changed, 0 insertions, 46 deletions
diff --git a/docs/man/nng_pipe_socket.3.adoc b/docs/man/nng_pipe_socket.3.adoc deleted file mode 100644 index 755ed776..00000000 --- a/docs/man/nng_pipe_socket.3.adoc +++ /dev/null @@ -1,46 +0,0 @@ -= nng_pipe_socket(3) -// -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> -// Copyright 2018 Capitar IT Group BV <info@capitar.com> -// -// 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_pipe_socket - return owning socket for pipe - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> - -nng_socket nng_pipe_socket(nng_pipe p); ----- - -== DESCRIPTION - -The `nng_pipe_socket()` function returns the xref:nng_socket.5.adoc[`nng_socket`] -associated with the pipe _p_. - -NOTE: The returned socket may be closed or in the process of closing, in -which case it will not be usable with other functions. - -== RETURN VALUES - -This function returns the socket associated with the pipe. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:nng_pipe.5.adoc[nng_pipe(5)], -xref:nng_socket.5.adoc[nng_socket(5)], -xref:nng.7.adoc[nng(7)] |