The branch OpenSSL_1_1_0-stable has been updated
via e7a5f50da09324aeb77386f30cd1110eb5e917f2 (commit)
from 3d040392ff68e71171cbd5750f1d76efdb0516ca (commit)
- Log -----------------------------------------------------------------
commit e7a5f50da09324aeb77386f30cd1110eb5e917f2
Author: Andrea Grandi <andrea.gra...@intel.com>
Date: Tue Oct 18 10:53:14 2016 +0100
Fix broken link to ASYNC_get_wait_ctx and rewrap the paragraph
Reviewed-by: Matt Caswell <m...@openssl.org>
Reviewed-by: Rich Salz <rs...@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/1745)
(cherry picked from commit 50c3fc00cc3090d082669591c0923a8468f2d8f9)
-----------------------------------------------------------------------
Summary of changes:
doc/crypto/ASYNC_WAIT_CTX_new.pod | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/doc/crypto/ASYNC_WAIT_CTX_new.pod
b/doc/crypto/ASYNC_WAIT_CTX_new.pod
index de1bd57..580c4e5 100644
--- a/doc/crypto/ASYNC_WAIT_CTX_new.pod
+++ b/doc/crypto/ASYNC_WAIT_CTX_new.pod
@@ -78,20 +78,20 @@ application will have to periodically "poll" the job by
attempting to restart it
to see if it is ready to continue.
Async aware code (e.g. engines) can get the current ASYNC_WAIT_CTX from the job
-via L<ASYNC_get_async_wait_ctx(3)> and provide a file descriptor to use for
-waiting on by calling ASYNC_WAIT_CTX_set_wait_fd(). Typically this would be
done
-by an engine immediately prior to calling ASYNC_pause_job() and not by end user
-code. An existing association with a file descriptor can be obtained using
+via L<ASYNC_get_wait_ctx(3)> and provide a file descriptor to use for waiting
+on by calling ASYNC_WAIT_CTX_set_wait_fd(). Typically this would be done by an
+engine immediately prior to calling ASYNC_pause_job() and not by end user code.
+An existing association with a file descriptor can be obtained using
ASYNC_WAIT_CTX_get_fd() and cleared using ASYNC_WAIT_CTX_clear_fd(). Both of
-these functions requires a B<key> value which is unique to the async aware
code.
-This could be any unique value but a good candidate might be the B<ENGINE *>
for
-the engine. The B<custom_data> parameter can be any value, and will be returned
-in a subsequent call to ASYNC_WAIT_CTX_get_fd(). The
+these functions requires a B<key> value which is unique to the async aware
+code. This could be any unique value but a good candidate might be the
+B<ENGINE *> for the engine. The B<custom_data> parameter can be any value, and
+will be returned 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. Note: The "cleanup" routine does not get called if the fd
-is cleared directly via a call to ASYNC_WAIT_CTX_clear_fd().
+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. 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
_____
openssl-commits mailing list
To unsubscribe: https://mta.openssl.org/mailman/listinfo/openssl-commits
