aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_pipe_dialer.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2025-01-14 08:26:14 -0800
committerGarrett D'Amore <garrett@damore.org>2025-01-14 08:26:14 -0800
commit6dc757342f5f9dedf38de356ae1802546f976bcc (patch)
tree87d931b409abcd6f4975c5742592b6d3464f24de /docs/man/nng_pipe_dialer.3.adoc
parent1b1f4609c6dad724b88dfb069b2260341e582906 (diff)
downloadnng-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_dialer.3.adoc')
-rw-r--r--docs/man/nng_pipe_dialer.3.adoc47
1 files changed, 0 insertions, 47 deletions
diff --git a/docs/man/nng_pipe_dialer.3.adoc b/docs/man/nng_pipe_dialer.3.adoc
deleted file mode 100644
index c2a68c5e..00000000
--- a/docs/man/nng_pipe_dialer.3.adoc
+++ /dev/null
@@ -1,47 +0,0 @@
-= nng_pipe_dialer(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_dialer - return dialer that created pipe
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-nng_dialer nng_pipe_dialer(nng_pipe p);
-----
-
-== DESCRIPTION
-
-The `nng_pipe_dialer()` function returns the xref:nng_dialer.5.adoc[`nng_dialer`]
-that created the pipe _p_.
-If the pipe was not created by a dialer, then the returned value will
-have an identifier (xref:nng_dialer_id.3.adoc[`nng_dialer_id()`]) of `-1`.
-
-== RETURN VALUES
-
-This function returns the dialer that created the pipe, unless it was
-not created by a dialer, in which case a value initialized with
-`NNG_DIALER_INITIALIZER` will be returned.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_pipe.5.adoc[nng_pipe(5)],
-xref:nng_dialer.5.adoc[nng_dialer(5)],
-xref:nng.7.adoc[nng(7)]