aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2023-12-15 13:52:27 -0800
committerGarrett D'Amore <garrett@damore.org>2023-12-15 13:52:27 -0800
commitc4d4d50cdc03d0d270f66f20ba7cd638018d6f11 (patch)
tree69db224649622aca0194ee1b708d3a8798963e5a /docs
parenta6de76c0b1e08ceba5c3e47dd1107f1a09490b0d (diff)
downloadnng-c4d4d50cdc03d0d270f66f20ba7cd638018d6f11.tar.gz
nng-c4d4d50cdc03d0d270f66f20ba7cd638018d6f11.tar.bz2
nng-c4d4d50cdc03d0d270f66f20ba7cd638018d6f11.zip
fixes #1721 docs should indicate nng_aio_wait must not be used from a callback
Diffstat (limited to 'docs')
-rw-r--r--docs/man/nng_aio_wait.3.adoc4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/man/nng_aio_wait.3.adoc b/docs/man/nng_aio_wait.3.adoc
index 18b735db..a1afb3e2 100644
--- a/docs/man/nng_aio_wait.3.adoc
+++ b/docs/man/nng_aio_wait.3.adoc
@@ -32,6 +32,10 @@ completed, then it returns immediately.
If a callback was set with _aio_ when it was allocated, then this
function will not be called until the callback has completed.
+IMPORTANT: This function should never be called from a function that itself
+is a callback of an xref:nng_aio.5.adoc[`aio`], either this one or any other.
+Doing so may result in a deadlock.
+
== RETURN VALUES
None.