diff options
| author | Garrett D'Amore <garrett@damore.org> | 2020-12-10 22:17:23 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2020-12-12 11:32:51 -0800 |
| commit | 2033988343bce413763d3e9664e3e8372da48591 (patch) | |
| tree | f39ce75c40dd94f95884d7d4c43a76df510a86bf /docs | |
| parent | b45f876d005371f62fc261a5584c4d7dafd7a0f7 (diff) | |
| download | nng-2033988343bce413763d3e9664e3e8372da48591.tar.gz nng-2033988343bce413763d3e9664e3e8372da48591.tar.bz2 nng-2033988343bce413763d3e9664e3e8372da48591.zip | |
fixes #1313 support deferred nng_aio destruction
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man/libnng.3.adoc | 1 | ||||
| -rw-r--r-- | docs/man/nng_aio_free.3.adoc | 9 |
2 files changed, 9 insertions, 1 deletions
diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc index ccc2732c..a09b1db1 100644 --- a/docs/man/libnng.3.adoc +++ b/docs/man/libnng.3.adoc @@ -170,6 +170,7 @@ The following functions are used in the asynchronous model: |xref:nng_aio_get_input.3.adoc[nng_aio_get_input()]|return input parameter |xref:nng_aio_get_msg.3.adoc[nng_aio_get_msg()]|get message from an asynchronous receive |xref:nng_aio_get_output.3.adoc[nng_aio_get_output()]|return output result +|xref:nng_aio_free.3.adoc[nng_aio_reap()]|reap asynchronous I/O handle |xref:nng_aio_result.3.adoc[nng_aio_result()]|return result of asynchronous operation |xref:nng_aio_set_input.3.adoc[nng_aio_set_input()]|set input parameter |xref:nng_aio_set_iov.3.adoc[nng_aio_set_iov()]|set scatter/gather vector diff --git a/docs/man/nng_aio_free.3.adoc b/docs/man/nng_aio_free.3.adoc index 31c75414..a8c5f566 100644 --- a/docs/man/nng_aio_free.3.adoc +++ b/docs/man/nng_aio_free.3.adoc @@ -1,6 +1,6 @@ = nng_aio_free(3) // -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> // // This document is supplied under the terms of the MIT License, a @@ -20,6 +20,7 @@ nng_aio_free - free asynchronous I/O handle #include <nng/nng.h> void nng_aio_free(nng_aio *aio); +void nng_aio_reap(nng_aio *aio); ---- == DESCRIPTION @@ -30,6 +31,12 @@ 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 xref:nng_aio_stop.3.adoc[`nng_aio_stop()`].) +The `nng_aio_reap()` function is the same as `nng_aio_free()`, but does +it's work in a background thread. +This can be useful to discard the _aio_ object from within the callback for the _aio_. + +IMPORTANT: Once either of these functions are called, the _aio_ object is invalid and must not be used again. + == RETURN VALUES None. |