xref: /freebsd-src/crypto/openssl/doc/man7/openssl-core_dispatch.h.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1*b077aed3SPierre Pronchery=pod
2*b077aed3SPierre Pronchery
3*b077aed3SPierre Pronchery=head1 NAME
4*b077aed3SPierre Pronchery
5*b077aed3SPierre Proncheryopenssl/core_dispatch.h
6*b077aed3SPierre Pronchery- OpenSSL provider dispatch numbers and function types
7*b077aed3SPierre Pronchery
8*b077aed3SPierre Pronchery=head1 SYNOPSIS
9*b077aed3SPierre Pronchery
10*b077aed3SPierre Pronchery #include <openssl/core_dispatch.h>
11*b077aed3SPierre Pronchery
12*b077aed3SPierre Pronchery=head1 DESCRIPTION
13*b077aed3SPierre Pronchery
14*b077aed3SPierre ProncheryThe F<< <openssl/core_dispatch.h> >> header defines all the operation
15*b077aed3SPierre Proncherynumbers, dispatch numbers and provider interface function types
16*b077aed3SPierre Proncherycurrently available.
17*b077aed3SPierre Pronchery
18*b077aed3SPierre ProncheryThe operation and dispatch numbers are represented with macros, which
19*b077aed3SPierre Proncheryare named as follows:
20*b077aed3SPierre Pronchery
21*b077aed3SPierre Pronchery=over 4
22*b077aed3SPierre Pronchery
23*b077aed3SPierre Pronchery=item operation numbers
24*b077aed3SPierre Pronchery
25*b077aed3SPierre ProncheryThese macros have the form C<OSSL_OP_I<opname>>.
26*b077aed3SPierre Pronchery
27*b077aed3SPierre Pronchery=item dipatch numbers
28*b077aed3SPierre Pronchery
29*b077aed3SPierre ProncheryThese macros have the form C<OSSL_FUNC_I<opname>_I<funcname>>, where
30*b077aed3SPierre ProncheryC<I<opname>> is the same as in the macro for the operation this
31*b077aed3SPierre Proncheryfunction belongs to.
32*b077aed3SPierre Pronchery
33*b077aed3SPierre Pronchery=back
34*b077aed3SPierre Pronchery
35*b077aed3SPierre ProncheryWith every dispatch number, there is an associated function type.
36*b077aed3SPierre Pronchery
37*b077aed3SPierre ProncheryFor further information, please see the L<provider(7)>
38*b077aed3SPierre Pronchery
39*b077aed3SPierre Pronchery=head1 SEE ALSO
40*b077aed3SPierre Pronchery
41*b077aed3SPierre ProncheryL<provider(7)>
42*b077aed3SPierre Pronchery
43*b077aed3SPierre Pronchery=head1 HISTORY
44*b077aed3SPierre Pronchery
45*b077aed3SPierre ProncheryThe types and macros described here were added in OpenSSL 3.0.
46*b077aed3SPierre Pronchery
47*b077aed3SPierre Pronchery=head1 COPYRIGHT
48*b077aed3SPierre Pronchery
49*b077aed3SPierre ProncheryCopyright 2020 The OpenSSL Project Authors. All Rights Reserved.
50*b077aed3SPierre Pronchery
51*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
52*b077aed3SPierre Proncherythis file except in compliance with the License.  You can obtain a copy
53*b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at
54*b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>.
55*b077aed3SPierre Pronchery
56*b077aed3SPierre Pronchery=cut
57