doc/man7/openssl-core_numbers.h.pod

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