From 74a12ffc8b37f2dae4b3002e86f33b8ca52df22d Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 29 Dec 2019 23:21:33 -0800 Subject: man page updates for 1.2 --- man/v1.2/nng_aio.5.html | 593 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 593 insertions(+) create mode 100644 man/v1.2/nng_aio.5.html (limited to 'man/v1.2/nng_aio.5.html') diff --git a/man/v1.2/nng_aio.5.html b/man/v1.2/nng_aio.5.html new file mode 100644 index 00000000..270cb1c0 --- /dev/null +++ b/man/v1.2/nng_aio.5.html @@ -0,0 +1,593 @@ +--- +version: 1.2 +layout: refman +--- + + + + + + + +nng_aio(5) + + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+typedef struct nng_aio nng_aio;
+
+
+
+
+
+

DESCRIPTION

+
+
+

An nng_aio is an opaque structure used in conjunction with +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 in nng also supports cancellation of +operations that are already in progress +(see nng_aio_cancel()), as well setting a maximum +timeout for them to complete within +(see nng_aio_set_timeout()).

+
+
+

It is also possible to initiate an asynchronous operation, and wait for it to +complete using nng_aio_wait().

+
+
+

These structures are created using the nng_aio_alloc(), +and destroyed using nng_aio_free().

+
+
+
+
+

SEE ALSO

+
+
+

nng_aio_abort(3), +nng_aio_alloc(3), +nng_aio_cancel(3), +nng_aio_count(3), +nng_aio_free(3), +nng_aio_get_input(3), +nng_aio_get_msg(3), +nng_aio_get_output(3), +nng_aio_result(3), +nng_aio_set_input(3), +nng_aio_set_iov(3), +nng_aio_set_msg(3), +nng_aio_set_timeout(3), +nng_aio_stop(3), +nng_aio_wait(3), +nng_strerror(3), +nng_aio(5), +nng(7)

+
+
+
+
+ + -- cgit v1.2.3-70-g09d2