openssl-core_dispatch.h.pod 1.2 KB

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