fixes #872 create unified nng_stream API

This is a major change, and includes changes to use a polymorphic
stream API for all transports.  There have been related bugs fixed
along the way.  Additionally the man pages have changed.

The old non-polymorphic APIs are removed now.  This is a breaking
change, but the old APIs were never part of any released public API.

1 files changed, 65 insertions, 0 deletions

diff --git a/docs/man/nng_stream_close.3str.adoc b/docs/man/nng_stream_close.3str.adoc
new file mode 100644
index 00000000..9e7b8d6a
--- /dev/null
+++ b/docs/man/nng_stream_close.3str.adoc
@@ -0,0 +1,65 @@
+= nng_stream_close(3str)
+//
+// Copyright 2019 Staysail Systems, Inc. <info@staysail.tech>
+// Copyright 2018 Capitar IT Group BV <info@capitar.com>
+// Copyright 2019 Devolutions <info@devolutions.net>
+//
+// 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_stream_close - close byte stream
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+
+void nng_stream_close(nng_stream *s);
+----
+
+== DESCRIPTION
+
+The `nng_stream_close()` function closes the
+xref:nng_stream.5.adoc[byte stream] _s_.
+
+If any operations are pending, such as
+xref:nng_stream_send.3str.adoc[`nng_stream_send()`]
+or
+xref:nng_stream_recv.3str.adoc[`nng_stream_recv()`],
+they will be terminated with
+an `NNG_ECLOSED` error condition.
+Also, any new operations will fail with `NNG_ECLOSED` after the connection
+is closed.
+
+NOTE: Closing the connection while data is in transmission will likely
+lead to loss of that data.
+There is no automatic linger or flush to ensure that the socket send buffers
+have completely transmitted.
+
+NOTE: Closing the connection does not free the resources associated with it.
+Once it is certain that no more operations are pending on the connection,
+it should be freed with
+xref:nng_stream_free.3str.adoc[`nng_stream_free()`].
+
+== RETURN VALUES
+
+None.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+[.text-left]
+xref:nng_strerror.3.adoc[nng_strerror(3)],
+xref:nng_stream_free.3str.adoc[nng_stream_free(3str)],
+xref:nng_stream_recv.3str.adoc[nng_stream_recv(3str)],
+xref:nng_stream_send.3str.adoc[nng_stream_send(3str)],
+xref:nng_stream.5.adoc[nng_stream(5)]