Document nng_aio_xxx asynchronous I/O API.

1 files changed, 58 insertions, 0 deletions

diff --git a/docs/nng_aio_stop.adoc b/docs/nng_aio_stop.adoc
new file mode 100644
index 00000000..9faa7361
--- /dev/null
+++ b/docs/nng_aio_stop.adoc
@@ -0,0 +1,58 @@
+= nng_aio_stop(3)
+:doctype: manpage
+:manmanual: nng
+:mansource: nng
+:manvolnum: 3
+:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \
+            Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \
+            {blank} + \
+            This document is supplied under the terms of the \
+            https://opensource.org/licenses/MIT[MIT License].
+
+== NAME
+
+nng_aio_stop - stop asynchronous I/O operation
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+void nng_aio_stop(nng_aio *aio);
+-----------
+
+== DESCRIPTION
+
+The `nng_aio_stop()` function stops the asynchronous I/O operation
+associated with _aio_ by aborting with `NNG_ECANCELED`, and then waits
+for it to complete or to be completely aborted.
+
+This is logically the equivalent of <<nng_aio_cancel#,nng_aio_cancel(3)>>
+followed by <<nng_aio_wait#,nng_aio_wait(3)>>, except that the asynchronous
+I/O handle may not be used for any further operations.
+
+TIP: When multiple asynchronous I/O handles are in use and need to be
+shut down, it is safest to stop all of them, before deallocating any of
+this with <<nng_aio_free#,nng_aio_free(3)>>, particularly if the callbacks
+might attempt to reschedule additional operations.
+
+== RETURN VALUES
+
+None.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+<<nng_aio_cancel#,nng_aio_cancel(3)>>,
+<<nng_aio_free#,nng_aio_free(3)>>,
+<<nng_aio_wait#,nng_aio_wait(3)>>,
+<<nng_aio_alloc#,nng_aio_alloc(3)>>,
+<<nng#,nng(7)>>
+
+== COPYRIGHT
+
+{copyright}