diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-26 09:15:24 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-26 09:15:44 -0800 |
| commit | 504d7b5a11bce8ab1ec1e18ff9c4a72dfd12a36f (patch) | |
| tree | d4e901f54aee00de9394beb615982aedb4017f7a | |
| parent | 8cb5ea107d10412490f9c9c5800614d490f3ce24 (diff) | |
| download | nng-504d7b5a11bce8ab1ec1e18ff9c4a72dfd12a36f.tar.gz nng-504d7b5a11bce8ab1ec1e18ff9c4a72dfd12a36f.tar.bz2 nng-504d7b5a11bce8ab1ec1e18ff9c4a72dfd12a36f.zip | |
Add a note that the AIO callback must not block.
| -rw-r--r-- | docs/man/nng_aio_alloc.adoc | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/man/nng_aio_alloc.adoc b/docs/man/nng_aio_alloc.adoc index 57054e04..2ca95829 100644 --- a/docs/man/nng_aio_alloc.adoc +++ b/docs/man/nng_aio_alloc.adoc @@ -30,7 +30,11 @@ with a completion callback of _callb_, which will be executed when an associated asynchronous operation finishes. It will be called with the argument _arg_. -Asynchronous I/O operations all take an "aio" handle such as allocated by +NOTE: The callback _callb_ must not perform any blocking operations, and +must complete it's execution quickly. If _callb_ does block, this can +lead ultimately to an apparent "hang" or deadlock in the application. + +Asynchronous I/O operations all take an _aio_ handle such as allocated by this function. Such operations are usually started by a function that returns immediately. The operation is then run asynchronously, and completes sometime later. When that operation is complete, the callback supplied here is called, |