fixes #2183 docs: convert AIO provider docs

5 files changed, 0 insertions, 280 deletions

diff --git a/docs/man/nng_aio_finish.3.adoc b/docs/man/nng_aio_finish.3.adoc
deleted file mode 100644
index a4855ec8..00000000
--- a/docs/man/nng_aio_finish.3.adoc
+++ /dev/null
@@ -1,59 +0,0 @@
-= nng_aio_finish(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_aio_finish - finish asynchronous I/O operation
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-void nng_aio_finish(nng_aio *aio, int err);
-----
-
-== DESCRIPTION
-
-The `nng_aio_finish()` function marks operation associated with _aio_ as
-complete, with the status _err_.
-This will be the result returned by
-xref:nng_aio_result.3.adoc[`nng_aio_result()`].
-
-This function causes the callback associated with the _aio_ to called.
-
-IMPORTANT: It is mandatory that operation providers call this function
-*exactly once* when they are finished with the operation.
-After calling this function they *must not* perform any further accesses
-to the _aio_.
-
-NOTE: This function is only for I/O providers (those actually performing
-the operation such as HTTP handler functions or transport providers); ordinary
-users of the _aio_ should not have any need for this function.
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_aio_reset.3.adoc[nng_aio_reset(3)],
-xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)],
-xref:nng_aio_start.3.adoc[nng_aio_start(3)],
-xref:nng_aio_result.3.adoc[nng_aio_result(3)],
-xref:nng_aio.5.adoc[nng_aio(5)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_aio_get_input.3.adoc b/docs/man/nng_aio_get_input.3.adoc
deleted file mode 100644
index ef331312..00000000
--- a/docs/man/nng_aio_get_input.3.adoc
+++ /dev/null
@@ -1,52 +0,0 @@
-= nng_aio_get_input(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_aio_get_input - return input parameter
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-void *nng_aio_get_input(nng_aio *aio, unsigned int index);
-----
-
-== DESCRIPTION
-
-The `nng_aio_get_input()` function returns the value of the input parameter
-previously set at _index_ on _aio_ with the
-xref:nng_aio_set_input.3.adoc[`nng_aio_set_input()`] function.
-
-The valid values of _index_ range from zero (0) to three (3), as no operation
-currently defined can accept more than four parameters.
-(This limit could increase in the future.)
-If the index supplied is outside of this range,
-or of the input parameter was not previously set, then `NULL` is returned.
-
-== RETURN VALUES
-
-Value previously set, or `NULL`.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_aio_get_output.3.adoc[nng_aio_get_output(3)],
-xref:nng_aio_set_input.3.adoc[nng_aio_set_input(3)],
-xref:nng_aio_result.3.adoc[nng_aio_result(3)],
-xref:nng_aio.5.adoc[nng_aio(5)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_aio_reset.3.adoc b/docs/man/nng_aio_reset.3.adoc
deleted file mode 100644
index 8f4ba514..00000000
--- a/docs/man/nng_aio_reset.3.adoc
+++ /dev/null
@@ -1,41 +0,0 @@
-= nng_aio_reset(3)
-//
-// Copyright 2024 Staysail Systems, Inc. <info@staysail.tech>
-//
-// 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_aio_reset - reset asynchronous I/O operation
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-void nng_aio_reset(nng_aio *aio);
-----
-
-== DESCRIPTION
-
-The `nng_aio_reset()` is used by providers to reset certain fields in the _aio_.
-This should be done before performing any operations on _aio_.
-
-NOTE: This function is only for I/O providers (those actually performing
-the operation such as HTTP handler functions or transport providers); ordinary
-users of the _aio_ should not call this function.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)],
-xref:nng_aio_start.3.adoc[nng_aio_start(3)],
-xref:nng_aio_finish.3.adoc[nng_aio_finish(3)],
-xref:nng_aio_result.3.adoc[nng_aio_result(3)],
-xref:nng_aio.5.adoc[nng_aio(5)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_aio_set_output.3.adoc b/docs/man/nng_aio_set_output.3.adoc
deleted file mode 100644
index 883598ce..00000000
--- a/docs/man/nng_aio_set_output.3.adoc
+++ /dev/null
@@ -1,59 +0,0 @@
-= nng_aio_set_output(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_aio_set_output - set output result
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-void nng_aio_set_output(nng_aio *aio, unsigned int index, void *result);
-----
-
-== DESCRIPTION
-
-The `nng_aio_set_output()` function sets the output result at _index_
-to _result_ for the asynchronous operation associated with _aio_.
-
-The type and semantics of output results are determined by specific
-operations; the operation must supply appropriate output results when
-the operation completes successfully.
-
-The valid values of _index_ range from zero (0) to three (3), as no operation
-currently defined can return more than four results.
-(This limit could increase in the future.)
-
-NOTE:  Note that attempts to set results with an _index_ greater than
-three (3) will be ignored.
-
-An output result set with this function may be retrieved later with
-the xref:nng_aio_get_output.3.adoc[`nng_aio_get_output()`] function.
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_aio_finish.3.adoc[nng_aio_finish(3)],
-xref:nng_aio_get_output.3.adoc[nng_aio_get_output(3)],
-xref:nng_aio_result.3.adoc[nng_aio_result(3)],
-xref:nng_aio.5.adoc[nng_aio(5)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_aio_start.3.adoc b/docs/man/nng_aio_start.3.adoc
deleted file mode 100644
index 4c5d090a..00000000
--- a/docs/man/nng_aio_start.3.adoc
+++ /dev/null
@@ -1,69 +0,0 @@
-= nng_aio_start(3)
-//
-// Copyright 2024 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_aio_start - start asynchronous I/O operation
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-typedef void (*nng_aio_cancelfn)(nng_aio *aio, void *arg, int err);
-
-void nng_aio_start(nng_aio *aio, nng_aio_cancelfn fn, void *arg);
-----
-
-== DESCRIPTION
-
-The `nng_aio_started()` function marks operation associated with _aio_ as
-being deferred for asynchronous completion, and also registers a cancellation
-function _fn_ and associated argument _arg_, thereby
-permitting the operation to be canceled.
-
-If the _aio_ is being canceled, the cancellation routine _fn_ will be called
-with the _aio_, the _arg_ specified by `nng_aio_start()`, and an error
-value in _err_, which is the reason that the operation is being canceled.
-
-The operation may not be cancelable; for example it may have already been
-completed, or be in a state where it is no longer possible to unschedule it.
-In this case, the _cancelfn_ should just return without making any changes.
-
-If the cancellation routine successfully canceled the operation, it should
-ensure that xref:nng_aio_finish.3.adoc[`nng_aio_finish()`] is called, with the
-error code specified by _err_.
-
-IMPORTANT: It is mandatory that I/O providers call
-xref:nng_aio_finish.3.adoc[`nng_aio_finish()`]
-*EXACTLY ONCE* when they are finished with the operation.
-
-NOTE: This function is only for I/O providers (those actually performing
-the operation such as HTTP handler functions or transport providers); ordinary
-users of the _aio_ should not call this function.
-
-NOTE: Care must be taken to ensure that cancellation and completion of
-the routine are multi-thread safe; this will usually involve the use
-of locks or other synchronization primitives.
-
-TIP: For operations that complete synchronously, without any need to be
-deferred, the provider should not bother to call `nng_aio_start()`,
-although it is harmless if it does.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_aio_cancel.3.adoc[nng_aio_cancel(3)],
-xref:nng_aio_finish.3.adoc[nng_aio_finish(3)],
-xref:nng_aio_result.3.adoc[nng_aio_result(3)],
-xref:nng_aio.5.adoc[nng_aio(5)],
-xref:nng.7.adoc[nng(7)]