diff options
author | Dr. Matthias St. Pierre <matthias.st.pierre@ncp-e.com> | 2020-06-21 01:21:19 +0200 |
---|---|---|
committer | Dr. Matthias St. Pierre <matthias.st.pierre@ncp-e.com> | 2020-06-24 22:01:22 +0200 |
commit | 23c48d94d4d34eedc15fa65e0fa0e38a6137e09f (patch) | |
tree | 1cb95463b3278767a65f853b2cc084790a247c44 /doc/man7/openssl-core_dispatch.h.pod | |
parent | 5b286641efef67aed5af026302b2176e3e368ae9 (diff) |
Rename <openssl/core_numbers.h> -> <openssl/core_dispatch.h>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/12222)
Diffstat (limited to 'doc/man7/openssl-core_dispatch.h.pod')
-rw-r--r-- | doc/man7/openssl-core_dispatch.h.pod | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/doc/man7/openssl-core_dispatch.h.pod b/doc/man7/openssl-core_dispatch.h.pod new file mode 100644 index 0000000000..a19e1331fa --- /dev/null +++ b/doc/man7/openssl-core_dispatch.h.pod @@ -0,0 +1,56 @@ +=pod + +=head1 NAME + +openssl/core_dispatch.h +- OpenSSL provider dispatch numbers and function types + +=head1 SYNOPSIS + + #include <openssl/core_dispatch.h> + +=head1 DESCRIPTION + +The F<< <openssl/core_dispatch.h> >> header defines all the operation +numbers, dispatch numbers and provider interface function types +currently available. + +The operation and dispatch numbers are represented with macros, which +are named as follows: + +=over 4 + +=item operation numbers + +These macros have the form C<OSSL_OP_I<opname>>. + +=item dipatch numbers + +These macros have the form C<OSSL_FUNC_I<opname>_I<funcname>>, where +C<I<opname>> is the same as in the macro for the operation this +function belongs to. + +=back + +With every dispatch number, there is an associated function type. + +For further information, please see the L<provider(7)> + +=head1 SEE ALSO + +L<provider(7)> + +=head1 HISTORY + +The types and macros described here were added in OpenSSL 3.0. + +=head1 COPYRIGHT + +Copyright 2020 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. + +=cut |