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