From 3079d4aa9bbbca02c36dcb7ff6a3f6d24bd21189 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Fri, 9 Nov 2018 19:59:29 -0800 Subject: man page updates for 1.1.0 --- man/v1.1.0/nng_aio_begin.3.html | 626 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 626 insertions(+) create mode 100644 man/v1.1.0/nng_aio_begin.3.html (limited to 'man/v1.1.0/nng_aio_begin.3.html') diff --git a/man/v1.1.0/nng_aio_begin.3.html b/man/v1.1.0/nng_aio_begin.3.html new file mode 100644 index 00000000..d9fe0ef5 --- /dev/null +++ b/man/v1.1.0/nng_aio_begin.3.html @@ -0,0 +1,626 @@ +--- +version: 1.1.0 +layout: refman +--- + + + + + + + +nng_aio_begin(3) + + + + + + + +
+
+

SYNOPSIS

+
+
+
+
#include <nng/nng.h>
+
+bool nng_aio_begin(nng_aio *aio);
+
+
+
+
+
+

DESCRIPTION

+
+
+

The nng_aio_begin() function is called by the I/O provider to indicate that +it is going to process the operation.

+
+
+

The function may return false, indicating that the aio has been closed +by the caller asynchronously. +In this case the provider should abandon the operation and do nothing else.

+
+
+

This operation should be called at the start of any I/O operation, and must +be called not more than once for a given I/O operation on a given aio.

+
+
+

Once this function is called, if true is returned, then the provider MUST +guarantee that nng_aio_finish() is called for the aio +exactly once, when the operation is complete or canceled.

+
+
+ + + + + +
+ + +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 call this function. +
+
+
+
+
+

RETURN VALUES

+
+
+ + + + + + + + + +
+true + +

The operation has been started.

+
+false + +

The operation cannot be started.

+
+
+
+
+
+

ERRORS

+
+
+

None.

+
+
+
+
+

SEE ALSO

+
+
+

nng_aio_alloc(3), +nng_aio_cancel(3), +nng_aio_defer(3), +nng_aio_finish(3), +nng_aio_result(3), +nng_aio(5), +nng(7)

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