diff options
| author | Matt Caswell <matt@openssl.org> | 2016-03-07 16:55:39 +0000 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2016-03-07 17:23:42 +0000 |
| commit | 667867cced0013c1cfd8d7a9efa43b8f2cebc942 (patch) | |
| tree | 2bf118d9a4d87308f837fecfa658d79fee4356c0 /doc | |
| parent | b8972edad65a5245645f40654b903dbcd1a4d5c1 (diff) | |
Add a function to detect if we have async or not
Add the ASYNC_is_capable() function and use it in speed.
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Rich Salz <rsalz@openssl.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/crypto/ASYNC_start_job.pod | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/doc/crypto/ASYNC_start_job.pod b/doc/crypto/ASYNC_start_job.pod index 81fdc97df4..c64af3d340 100644 --- a/doc/crypto/ASYNC_start_job.pod +++ b/doc/crypto/ASYNC_start_job.pod @@ -4,8 +4,8 @@ ASYNC_init_thread, ASYNC_cleanup_thread, ASYNC_start_job, ASYNC_pause_job, ASYNC_in_job, ASYNC_get_wait_fd, ASYNC_set_wait_fd, ASYNC_clear_wait_fd, -ASYNC_get_current_job, ASYNC_block_pause, ASYNC_unblock_pause - asynchronous job -management functions +ASYNC_get_current_job, ASYNC_block_pause, ASYNC_unblock_pause, ASYNC_is_capable +- asynchronous job management functions =head1 SYNOPSIS @@ -23,6 +23,8 @@ management functions void ASYNC_block_pause(void); void ASYNC_unblock_pause(void); + int ASYNC_is_capable(void); + =head1 DESCRIPTION OpenSSL implements asynchronous capabilities through an ASYNC_JOB. This @@ -137,6 +139,9 @@ ASYNC_block_pause() immediately after aquiring the lock and ASYNC_unblock_pause() immediately before releasing it then this situation cannot occur. +Some platforms cannot support async operations. The ASYNC_is_capable() function +can be used to detect whether the current platform is async capable or not. + =head1 RETURN VALUES ASYNC_init_thread returns 1 on success or 0 otherwise. @@ -153,6 +158,9 @@ NULL if not within the context of a job. ASYNC_get_wait_ctx() returns a pointer to the ASYNC_WAIT_CTX for the job. +ASYNC_is_capable() returns 1 if the current platform is async capable or 0 +otherwise. + =head1 EXAMPLE The following example demonstrates how to use most of the core async APIs: @@ -295,8 +303,9 @@ L<crypto(3)>, L<ERR_print_errors(3)> =head1 HISTORY -ASYNC_init, ASYNC_init_thread, ASYNC_cleanup, ASYNC_cleanup_thread, -ASYNC_start_job, ASYNC_pause_job, ASYNC_get_wait_fd, ASYNC_get_current_job, -ASYNC_wake, ASYNC_clear_wake were first added to OpenSSL 1.1.0. +ASYNC_init_thread, ASYNC_cleanup_thread, +ASYNC_start_job, ASYNC_pause_job, ASYNC_get_current_job, ASYNC_get_wait_ctx(), +ASYNC_block_pause(), ASYNC_unblock_pause() and ASYNC_is_capable() were first +added to OpenSSL 1.1.0. =cut |