aboutsummaryrefslogtreecommitdiff
path: root/doc/crypto
diff options
context:
space:
mode:
authorMatt Caswell <matt@openssl.org>2016-02-29 12:15:27 +0000
committerMatt Caswell <matt@openssl.org>2016-02-29 12:58:44 +0000
commit83856523c1d07abbacc6bef0e33ad3a89aacbf2a (patch)
tree7b59649ce8c9e54843e92163cd3084437c4c0d1d /doc/crypto
parentff75a25749c7fceaff7503af6f09d4299a052996 (diff)
downloadopenssl-83856523c1d07abbacc6bef0e33ad3a89aacbf2a.zip
openssl-83856523c1d07abbacc6bef0e33ad3a89aacbf2a.tar.gz
openssl-83856523c1d07abbacc6bef0e33ad3a89aacbf2a.tar.bz2
Clarify ASYNC_WAIT_CTX_clear_fd() docs
Clarify that the "cleanup" routing does not get called if you invoke ASYNC_WAIT_CTX_clear_fd() directly. Reviewed-by: Richard Levitte <levitte@openssl.org>
Diffstat (limited to 'doc/crypto')
-rw-r--r--doc/crypto/ASYNC_WAIT_CTX_new.pod3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/crypto/ASYNC_WAIT_CTX_new.pod b/doc/crypto/ASYNC_WAIT_CTX_new.pod
index b70f730..c4e4d0e 100644
--- a/doc/crypto/ASYNC_WAIT_CTX_new.pod
+++ b/doc/crypto/ASYNC_WAIT_CTX_new.pod
@@ -90,7 +90,8 @@ in a subsequent call to ASYNC_WAIT_CTX_get_fd(). The
ASYNC_WAIT_CTX_set_wait_fd() function also expects a pointer to a "cleanup"
routine. This can be NULL but if provided will automatically get called when the
ASYNC_WAIT_CTX is freed, and gives the engine the opportunity to close the fd or
-any other resources.
+any other resources. Note: The "cleanup" routine does not get called if the fd
+is cleared directly via a call to ASYNC_WAIT_CTX_clear_fd().
An example of typical usage might be an async capable engine. User code would
initiate cryptographic operations. The engine would initiate those operations