From 68f3fd06531455aec4b2332bed1592795e69c3fa Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Mon, 5 Feb 2018 11:17:15 -0800 Subject: Document nng_aio_xxx asynchronous I/O API. --- docs/nng_aio_wait.adoc | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 docs/nng_aio_wait.adoc (limited to 'docs/nng_aio_wait.adoc') diff --git a/docs/nng_aio_wait.adoc b/docs/nng_aio_wait.adoc new file mode 100644 index 00000000..ba9347c4 --- /dev/null +++ b/docs/nng_aio_wait.adoc @@ -0,0 +1,51 @@ += nng_aio_wait(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_wait - wait for asynchronous I/O operation + +== SYNOPSIS + +[source, c] +----------- +#include + +void nng_aio_wait(nng_aio *aio); +----------- + + +== DESCRIPTION + +The `nng_aio_wait()` function waits for an asynchronous I/O operation +to complete. If the operation has not been started, or has already +completed, then it returns immediately. + +If the a callback was set with _aio_ when it was allocated, then this +function will not be called until the callback has completed. + +== RETURN VALUES + +None. + +== ERRORS + +None. + +== SEE ALSO + +<>, +<>, +<> + +== COPYRIGHT + +{copyright} -- cgit v1.2.3-70-g09d2