summaryrefslogtreecommitdiff
path: root/docs/man/nng_pipe.5.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-04-30 21:41:40 -0700
committerGarrett D'Amore <garrett@damore.org>2018-05-01 12:27:19 -0700
commit4998964a435fe0f02a2d81b01fdb837214674e72 (patch)
treedc5fe29da0574fc1510ab6f9b23b54ffd68cd97b /docs/man/nng_pipe.5.adoc
parent63bdb2c28bc185096e579d1922d57cb71ecaa36b (diff)
downloadnng-4998964a435fe0f02a2d81b01fdb837214674e72.tar.gz
nng-4998964a435fe0f02a2d81b01fdb837214674e72.tar.bz2
nng-4998964a435fe0f02a2d81b01fdb837214674e72.zip
fixes #381 Want comparators for various types
Diffstat (limited to 'docs/man/nng_pipe.5.adoc')
-rw-r--r--docs/man/nng_pipe.5.adoc14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/man/nng_pipe.5.adoc b/docs/man/nng_pipe.5.adoc
index 39247fbd..a7423884 100644
--- a/docs/man/nng_pipe.5.adoc
+++ b/docs/man/nng_pipe.5.adoc
@@ -51,11 +51,25 @@ Pipe objects may be destroyed by the
They are also closed when their "`owning`" dialer or listener is closed,
or when the remote peer closes the underlying connection.
+[[NNG_PIPE_INITIALIZER]]
+=== Initialization
+
+A pipe may be initialized using the macro `NNG_PIPE_INITIALIZER`
+before it is opened, to prevent confusion with valid open pipes.
+
+For example:
+
+[source, c]
+----
+nng_pipe p = NNG_PIPE_INITIALIZER;
+----
+
== SEE ALSO
<<nng_msg_get_pipe.3#,nng_msg_get_pipe(3)>>,
<<nng_pipe_close.3#,nng_pipe_close(3)>>,
<<nng_pipe_getopt.3#,nng_pipe_getopt(3)>>,
+<<nng_pipe_id.3#,nng_pipe_id(3)>>,
<<nng_dialer.5#,nng_dialer(5)>>,
<<nng_listener.5#,nng_listener(5)>>,
<<nng_options.5#,nng_options(5)>>,