aboutsummaryrefslogtreecommitdiff
path: root/docs/ref/api/aio/aio_cancel.md
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-10-18 22:32:48 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-18 22:32:48 -0700
commitcaa25a822565687833ffe6caf211a55c0cb95a65 (patch)
treed31140297a851961fc123dfb29db5697e9a17bac /docs/ref/api/aio/aio_cancel.md
parentd9b0ab96036890a254f021d480aa893228c22cc0 (diff)
downloadnng-caa25a822565687833ffe6caf211a55c0cb95a65.tar.gz
nng-caa25a822565687833ffe6caf211a55c0cb95a65.tar.bz2
nng-caa25a822565687833ffe6caf211a55c0cb95a65.zip
aio cancellation docs converted to mdbook
Diffstat (limited to 'docs/ref/api/aio/aio_cancel.md')
-rw-r--r--docs/ref/api/aio/aio_cancel.md55
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/ref/api/aio/aio_cancel.md b/docs/ref/api/aio/aio_cancel.md
new file mode 100644
index 00000000..8d4e904b
--- /dev/null
+++ b/docs/ref/api/aio/aio_cancel.md
@@ -0,0 +1,55 @@
+= nng_aio_abort(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_abort - abort asynchronous I/O operation
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+
+void nng_aio_abort(nng_aio *aio, int err);
+----
+
+== DESCRIPTION
+
+The `nng_aio_abort()` function aborts an operation previously started
+with the handle _aio_.
+If the operation is aborted, then the callback
+for the handle will be called, and the function
+xref:nng_aio_result.3.adoc[`nng_aio_result()`] will return the error _err_.
+
+This function does not wait for the operation to be fully aborted, but
+returns immediately.
+
+If no operation is currently in progress (either because it has already
+finished, or no operation has been started yet), then this function
+has no effect.
+
+== RETURN VALUES
+
+None.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+[.text-left]
+xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)],
+xref:nng_aio_cancel.3.adoc[nng_aio_cancel(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)]