From 159dc95695515db767e208c41d5f44b334b71adc Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Wed, 2 May 2018 16:01:22 -0700
Subject: fixes #389 Need pipe notification callbacks

This adds a new pipe event notification API (callbacks called
on either pipe add or remove), including both tests and docs.

Also supporting APIs to get the socket or endpoint associated
with a pipe are included (tested and documented as well.)
---
 docs/man/nng_pipe_dialer.3.adoc | 46 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 docs/man/nng_pipe_dialer.3.adoc

(limited to 'docs/man/nng_pipe_dialer.3.adoc')

diff --git a/docs/man/nng_pipe_dialer.3.adoc b/docs/man/nng_pipe_dialer.3.adoc
new file mode 100644
index 00000000..476ab1be
--- /dev/null
+++ b/docs/man/nng_pipe_dialer.3.adoc
@@ -0,0 +1,46 @@
+= 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 `<<nng_dialer.5#,nng_dialer>>`
+that created the pipe _p_.
+If the pipe was not created by a dialer, then the returned value will
+have an identifier (`<<nng_dialer_id.3#,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
+
+<<nng_pipe.5#,nng_pipe(5)>>,
+<<nng_dialer.5#,nng_dialer(5)>>,
+<<nng.7#,nng(7)>>
-- 
cgit v1.2.3-70-g09d2