aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_aio_finish.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2025-10-10 07:59:34 -0700
committerGarrett D'Amore <garrett@damore.org>2025-10-10 21:53:00 -0700
commitb98e03b26bfc593326bd7c1d56fd69626f6a93cb (patch)
tree0e8d9d395e3b9e4f2a92dd5f984dfca984f339da /docs/man/nng_aio_finish.3.adoc
parentb86377903b9ea64bf728a4538eea4d0c8c78653e (diff)
downloadnng-b98e03b26bfc593326bd7c1d56fd69626f6a93cb.tar.gz
nng-b98e03b26bfc593326bd7c1d56fd69626f6a93cb.tar.bz2
nng-b98e03b26bfc593326bd7c1d56fd69626f6a93cb.zip
fixes #2183 docs: convert AIO provider docs
Diffstat (limited to 'docs/man/nng_aio_finish.3.adoc')
-rw-r--r--docs/man/nng_aio_finish.3.adoc59
1 files changed, 0 insertions, 59 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)]