summaryrefslogtreecommitdiff
path: root/docs/reference/src/api/nng_aio.md
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-03-24 22:19:42 -0700
committerGarrett D'Amore <garrett@damore.org>2024-03-24 22:19:42 -0700
commit331bd5a7c360083f245fe6c82afa38dd05c4a9c9 (patch)
treef7a50976a4a6a717660d1c94a9808e896c3c2059 /docs/reference/src/api/nng_aio.md
parent962553386968a528593665e228b9424de84d7f4e (diff)
downloadnng-331bd5a7c360083f245fe6c82afa38dd05c4a9c9.tar.gz
nng-331bd5a7c360083f245fe6c82afa38dd05c4a9c9.tar.bz2
nng-331bd5a7c360083f245fe6c82afa38dd05c4a9c9.zip
More org stuff
Diffstat (limited to 'docs/reference/src/api/nng_aio.md')
-rw-r--r--docs/reference/src/api/nng_aio.md59
1 files changed, 0 insertions, 59 deletions
diff --git a/docs/reference/src/api/nng_aio.md b/docs/reference/src/api/nng_aio.md
deleted file mode 100644
index 667e785c..00000000
--- a/docs/reference/src/api/nng_aio.md
+++ /dev/null
@@ -1,59 +0,0 @@
-# nng_aio
-
-## NAME
-
-nng_aio --- asynchronous I/O handle
-
-```c
-#include <nng/nng.h>
-
-typedef struct nng_aio nng_aio;
-```
-
-## DESCRIPTION
-
-An `nng_aio`{{hi:aio}} is an opaque structure used in conjunction with
-{{i:asynchronous I/O}} operations.
-Every asynchronous operation uses one of these structures, each of which
-can only be used with a single operation at a time.
-
-Asynchronous operations are performed without blocking calling application
-threads.
-Instead the application registers a callback function to be executed
-when the operation is complete (whether successfully or not).
-This callback will be executed exactly once.
-
-The asynchronous I/O framework also supports cancellation of
-operations that are already in progress
-(see [`nng_aio_cancel()`](nng_aio_cancel.md)), as well setting a maximum
-timeout for them to complete within
-(see [`nng_aio_set_timeout()`](nng_aio_set_timeout.md)).
-
-It is also possible to initiate an asynchronous operation, and wait for it to
-complete [`nng_aio_wait()`](nng_aio_wait.md).
-
-These structures are created using the [`nng_aio_alloc()`](nng_aio_alloc.md),
-and destroyed using [`nng_aio_free()`](nng_aio_free.md).
-
-> [!IMPORTANT]
-> A given `nng_aio` can only have a single operation in progress
-> at any given time. Attempts to reuse an `nng_aio` while another
-> operation is in progress will generally cause a crash.
-
-## SEE ALSO
-
-[nng_aio_abort()](nng_aio_abort.md),
-[nng_aio_alloc()](nng_aio_alloc.md),
-[nng_aio_cancel()](nng_aio_cancel.md),
-[nng_aio_count()](nng_aio_count.md),
-[nng_aio_free()](nng_aio_free.md),
-[nng_aio_get_input()](nng_aio_get_input.md),
-[nng_aio_get_msg()](nng_aio_get_msg.md),
-[nng_aio_get_output()](nng_aio_get_output.md),
-[nng_aio_result()](nng_aio_result.md),
-[nng_aio_set_input()](nng_aio_set_input.md),
-[nng_aio_set_iov()](nng_aio_set_iov.md),
-[nng_aio_set_msg()](nng_aio_set_msg.md),
-[nng_aio_set_timeout()](nng_aio_set_timeout.md),
-[nng_aio_stop()](nng_aio_stop.md),
-[nng_aio_wait()](nng_aio_wait.md),