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_free.adoc | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 docs/nng_aio_free.adoc (limited to 'docs/nng_aio_free.adoc') diff --git a/docs/nng_aio_free.adoc b/docs/nng_aio_free.adoc new file mode 100644 index 00000000..79848485 --- /dev/null +++ b/docs/nng_aio_free.adoc @@ -0,0 +1,50 @@ += nng_aio_free(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_free - free asynchronous I/O handle + +== SYNOPSIS + +[source, c] +----------- +#include + +void nng_aio_free(nng_aio *aio); +----------- + + +== DESCRIPTION + +The `nng_aio_free()` function frees an allocated asynchronous I/O handle. +If any operation is in progress, the operation is canceled, and the +caller is blocked until the operation is completely canceled, to ensure +that it is safe to deallocate the handle and any associated resources. +(This is done by implicitly calling <>.) + +== RETURN VALUES + +None. + +== ERRORS + +None. + +== SEE ALSO + +<>, +<>, +<> + +== COPYRIGHT + +{copyright} -- cgit v1.2.3-70-g09d2