generic-library/openssl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clarify ASYNC_WAIT_CTX_clear_fd() docs

Browse Source 
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>
This commit is contained in:
Matt Caswell
2016-02-29 12:15:27 +00:00
parent ff75a25749
commit 83856523c1
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
crypto/async/async_wait.c
View File

@@ -191,7 +191,8 @@ int ASYNC_WAIT_CTX_clear_fd(ASYNC_WAIT_CTX *ctx, const void *key)
if (curr->key == key) { if (curr->key == key) {
/* /*
* Mark it as deleted. We don't call cleanup if explicitly asked * 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; curr->del = 1;
ctx->numdel++; ctx->numdel++;

3
doc/crypto/ASYNC_WAIT_CTX_new.pod
View File

@@ -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" 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 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 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 An example of typical usage might be an async capable engine. User code would
initiate cryptographic operations. The engine would initiate those operations initiate cryptographic operations. The engine would initiate those operations