diff options
| author | Matt Caswell <matt@openssl.org> | 2016-02-29 12:15:27 +0000 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2016-02-29 12:58:44 +0000 |
| commit | 83856523c1d07abbacc6bef0e33ad3a89aacbf2a (patch) | |
| tree | 7b59649ce8c9e54843e92163cd3084437c4c0d1d | |
| parent | ff75a25749c7fceaff7503af6f09d4299a052996 (diff) | |
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>
| -rw-r--r-- | crypto/async/async_wait.c | 3 | ||||
| -rw-r--r-- | doc/crypto/ASYNC_WAIT_CTX_new.pod | 3 |
2 files changed, 4 insertions, 2 deletions
diff --git a/crypto/async/async_wait.c b/crypto/async/async_wait.c index 9d90e524c3..94f1a6b4e0 100644 --- a/crypto/async/async_wait.c +++ b/crypto/async/async_wait.c @@ -191,7 +191,8 @@ int ASYNC_WAIT_CTX_clear_fd(ASYNC_WAIT_CTX *ctx, const void *key) if (curr->key == key) { /* * Mark it as deleted. We don't call cleanup if explicitly asked - * to clear an fd. We assume the caller is going to do that + * to clear an fd. We assume the caller is going to do that (if + * appropriate). */ curr->del = 1; ctx->numdel++; diff --git a/doc/crypto/ASYNC_WAIT_CTX_new.pod b/doc/crypto/ASYNC_WAIT_CTX_new.pod index b70f730f5e..c4e4d0e38d 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 |