diff options
| author | Pauli <pauli@openssl.org> | 2021-05-21 08:54:07 +1000 |
|---|---|---|
| committer | Pauli <pauli@openssl.org> | 2021-05-24 09:39:15 +1000 |
| commit | bca0ffe8b3f229b47a515048505736708e38095b (patch) | |
| tree | 8c4c1a59c31d2d3c178dde284e96167d9496520f /doc/man7/provider-base.pod | |
| parent | c9732f095363251131e6e6a4cbbe45deea285ed0 (diff) | |
| download | openssl-new-bca0ffe8b3f229b47a515048505736708e38095b.tar.gz | |
doc: update core_thread_start() documentation
It is now passed an arugment to pass to the callback
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15278)
Diffstat (limited to 'doc/man7/provider-base.pod')
| -rw-r--r-- | doc/man7/provider-base.pod | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/man7/provider-base.pod b/doc/man7/provider-base.pod index 10ad301fb4..292752afe9 100644 --- a/doc/man7/provider-base.pod +++ b/doc/man7/provider-base.pod @@ -21,7 +21,8 @@ provider-base typedef void (*OSSL_thread_stop_handler_fn)(void *arg); int core_thread_start(const OSSL_CORE_HANDLE *handle, - OSSL_thread_stop_handler_fn handfn); + OSSL_thread_stop_handler_fn handfn, + void *arg); OPENSSL_CORE_CTX *core_get_libctx(const OSSL_CORE_HANDLE *handle); void core_new_error(const OSSL_CORE_HANDLE *handle); @@ -192,13 +193,14 @@ core_get_params() retrieves parameters from the core for the given I<handle>. See L</Core parameters> below for a description of currently known parameters. -The core_thread_start() function informs the core that the provider has started +The core_thread_start() function informs the core that the provider has stated an interest in the current thread. The core will inform the provider when the thread eventually stops. It must be passed the I<handle> for this provider, as well as a callback I<handfn> which will be called when the thread stops. The -callback will subsequently be called from the thread that is stopping and gets -passed the provider context as an argument. This may be useful to perform thread -specific clean up such as freeing thread local variables. +callback will subsequently be called, with the supplied argument I<arg>, from +the thread that is stopping and gets passed the provider context as an +argument. This may be useful to perform thread specific clean up such as +freeing thread local variables. core_get_libctx() retrieves the library context in which the library object for the current provider is stored, accessible through the I<handle>. |