From 4998964a435fe0f02a2d81b01fdb837214674e72 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Mon, 30 Apr 2018 21:41:40 -0700
Subject: fixes #381 Want comparators for various types

---
 docs/man/nng_pipe_id.3.adoc | 50 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 docs/man/nng_pipe_id.3.adoc

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

diff --git a/docs/man/nng_pipe_id.3.adoc b/docs/man/nng_pipe_id.3.adoc
new file mode 100644
index 00000000..b327dac2
--- /dev/null
+++ b/docs/man/nng_pipe_id.3.adoc
@@ -0,0 +1,50 @@
+= nng_pipe_id(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_id - return numeric pipe identifier
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+
+int nng_pipe_id(nng_pipe p);
+----
+
+== DESCRIPTION
+
+The `nng_pipe_id()` function returns a positive identifier for the pipe _p_,
+if it is valid.
+Otherwise it returns `-1`.
+
+NOTE: A pipe is considered valid if it was ever opened with
+<<nng_pipe_open.3#,`nng_pipe_open`>> function.
+Pipes that are allocated on the stack or statically should be
+initialized with the macro
+<<nng_pipe.5#NNG_PIPE_INITIALIZER,`NNG_PIPE_INITIALIZER`>> to ensure that
+they cannot be confused with a valid pipe before they are opened.
+
+== RETURN VALUES
+
+This function returns the positive value for the pipe identifier, or
+`-1` if the pipe is invalid.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+<<nng_pipe.5#,nng_pipe(5)>>,
+<<nng.7#,nng(7)>>
-- 
cgit v1.2.3-70-g09d2