docs: start of streams API documentation

4 files changed, 0 insertions, 274 deletions

diff --git a/docs/man/nng_stream_close.3str.adoc b/docs/man/nng_stream_close.3str.adoc
deleted file mode 100644
index 9e7b8d6a..00000000
--- a/docs/man/nng_stream_close.3str.adoc
+++ /dev/null
@@ -1,65 +0,0 @@
-= 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)]
diff --git a/docs/man/nng_stream_free.3str.adoc b/docs/man/nng_stream_free.3str.adoc
deleted file mode 100644
index 30679458..00000000
--- a/docs/man/nng_stream_free.3str.adoc
+++ /dev/null
@@ -1,61 +0,0 @@
-= nng_stream_free(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_free - free byte stream
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-void nng_stream_free(nng_stream *s);
-----
-
-== DESCRIPTION
-
-The `nng_stream_free()` function closes the
-xref:nng_stream.5.adoc[byte stream] _s_,
-and frees the underlying resources associated with it.
-
-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.
-
-WARNING: It is important that the application ensure that no further accesses
-are made to _s_, as the memory backing it will be reclaimed for other uses.
-
-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.
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_stream_close.3str.adoc[nng_stream_close(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)]
diff --git a/docs/man/nng_stream_recv.3str.adoc b/docs/man/nng_stream_recv.3str.adoc
deleted file mode 100644
index 148be978..00000000
--- a/docs/man/nng_stream_recv.3str.adoc
+++ /dev/null
@@ -1,74 +0,0 @@
-= nng_stream_recv(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_recv - receive from byte stream
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-void nng_stream_recv(nng_stream *s, nng_aio *aio);
-----
-
-== DESCRIPTION
-
-The `nng_stream_recv()` function starts an asynchronous receive from the
-xref:nng_stream.5.adoc[byte stream] _s_
-into the scatter/gather vector located in the
-asynchronous I/O structure _aio_.
-
-NOTE: The
-xref:nng_aio_set_iov.3.adoc[`nng_aio_set_iov()`] function must have been
-called first, to set the scatter/gather vector for _aio_.
-
-This function returns immediately, with no return value.
-Completion of the operation is signaled via the _aio_,
-and the final result may be obtained via
-xref:nng_aio_result.3.adoc[`nng_aio_result()`].
-That result will either be zero or an error code.
-
-The I/O operation completes as soon as at least one byte has been
-received, or an error has occurred.
-Therefore, the number of bytes read may be less than requested.
-The actual number of bytes read can be determined with
-xref:nng_aio_count.3.adoc[`nng_aio_count()`].
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-[horizontal]
-`NNG_ECANCELED`:: The operation was canceled.
-`NNG_ECLOSED`:: The connection was closed.
-`NNG_ECONNRESET`:: The peer closed the connection.
-`NNG_ECONNSHUT`:: Remote peer shutdown after sending data.
-`NNG_EINVAL`:: The _aio_ does not contain a valid scatter/gather vector.
-`NNG_ENOMEM`:: Insufficient free memory to perform the operation.
-`NNG_ETIMEDOUT`:: Timeout waiting for data from the connection.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)],
-xref:nng_aio_count.3.adoc[nng_aio_count(3)],
-xref:nng_aio_result.3.adoc[nng_aio_result(3)],
-xref:nng_aio_set_iov.3.adoc[nng_aio_set_iov(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_stream_close.3str.adoc[nng_stream_close(3str)],
-xref:nng_stream_send.3str.adoc[nng_stream_send(3str)],
-xref:nng_stream.5.adoc[nng_stream(5)]
diff --git a/docs/man/nng_stream_send.3str.adoc b/docs/man/nng_stream_send.3str.adoc
deleted file mode 100644
index 5a53e63c..00000000
--- a/docs/man/nng_stream_send.3str.adoc
+++ /dev/null
@@ -1,74 +0,0 @@
-= nng_stream_send(3str)
-//
-// Copyright 2020 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_send - send to byte stream
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-void nng_stream_send(nng_stream *s, nng_aio *aio);
-----
-
-== DESCRIPTION
-
-The `nng_stream_send()` function starts an asynchronous send over the
-xref:nng_stream.5.adoc[byte stream] _s_
-from the scatter/gather vector located in the
-asynchronous I/O structure _aio_.
-
-NOTE: The
-xref:nng_aio_set_iov.3.adoc[`nng_aio_set_iov()`]
-function must have been
-called first, to set the scatter/gather vector for _aio_.
-
-This function returns immediately, with no return value.
-Completion of the operation is signaled via the _aio_, and the final
-result may be obtained via
-xref:nng_aio_result.3.adoc[`nng_aio_result()`].
-That result will either be zero or an error code.
-
-The I/O operation completes as soon as at least one byte has been
-sent, or an error has occurred.
-Therefore, the number of bytes sent may be less than requested.
-The actual number of bytes sent can be determined with
-xref:nng_aio_count.3.adoc[`nng_aio_count()`].
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-[horizontal]
-`NNG_ECANCELED`:: The operation was canceled.
-`NNG_ECLOSED`:: The connection was closed.
-`NNG_ECONNRESET`:: The peer closed the connection.
-`NNG_EINVAL`:: The _aio_ does not contain a valid scatter/gather vector.
-`NNG_ENOMEM`:: Insufficient free memory to perform the operation.
-`NNG_ETIMEDOUT`:: Timeout waiting for data from the connection.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)],
-xref:nng_aio_count.3.adoc[nng_aio_count(3)],
-xref:nng_aio_result.3.adoc[nng_aio_result(3)],
-xref:nng_aio_set_iov.3.adoc[nng_aio_set_iov(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_stream_close.3str.adoc[nng_stream_close(3str)],
-xref:nng_stream_recv.3str.adoc[nng_stream_recv(3str)],
-xref:nng_stream.5.adoc[nng_stream(5)]