diff options
| author | Richard Levitte <levitte@openssl.org> | 2019-11-11 18:38:57 +0100 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2019-11-14 08:22:29 +0100 |
| commit | 10e7216e502916f8e7917ac4f21411fffd1fb882 (patch) | |
| tree | 1c5727e7b62607857842f329c51daaae7518b745 /doc/man7/openssl-core.h.pod | |
| parent | c31950b964a2f3f7b9e6ad98076954178ee1e77d (diff) | |
CORE: Add a generic callback function type
This offers a very generic way to define a callback as well as calling
it.
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10412)
Diffstat (limited to 'doc/man7/openssl-core.h.pod')
| -rw-r--r-- | doc/man7/openssl-core.h.pod | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/man7/openssl-core.h.pod b/doc/man7/openssl-core.h.pod index a7f209b104..55d53fe262 100644 --- a/doc/man7/openssl-core.h.pod +++ b/doc/man7/openssl-core.h.pod @@ -74,6 +74,18 @@ parameters, and to describe parameters. B<OSSL_PARAM> is further described in L<OSSL_PARAM(3)> +=item B<OSSL_CALLBACK> + +This is a function type for a generic callback function: + + typedef int (OSSL_CALLBACK)(const OSSL_PARAM params[], void *arg); + +A function that takes a pointer of this type should also take a +pointer to caller data. When calling this callback, the function is +expected to build an B<OSSL_PARAM> array of data it wants or is +expected to pass back, and pass that as I<params>, as well as +the caller data pointer it received, as I<arg>. + =back =head1 SEE ALSO |