OSSL_QUIC_client_method.pod 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. =pod
  2. =head1 NAME
  3. OSSL_QUIC_client_method, OSSL_QUIC_client_thread_method,
  4. OSSL_QUIC_server_method
  5. - Provide SSL_METHOD objects for QUIC enabled functions
  6. =head1 SYNOPSIS
  7. #include <openssl/quic.h>
  8. const SSL_METHOD *OSSL_QUIC_client_method(void);
  9. const SSL_METHOD *OSSL_QUIC_client_thread_method(void);
  10. const SSL_METHOD *OSSL_QUIC_server_method(void);
  11. =head1 DESCRIPTION
  12. The OSSL_QUIC_client_method(), OSSL_QUIC_client_thread_method(), and
  13. OSSL_QUIC_server_method() functions provide methods for the
  14. L<SSL_CTX_new_ex(3)> function to provide QUIC protocol support.
  15. The OSSL_QUIC_client_thread_method() uses threads to allow for a blocking
  16. mode of operation and avoid the need to return control to the
  17. OpenSSL library for processing time based events.
  18. The OSSL_QUIC_client_method() does not use threads and depends on
  19. nonblocking mode of operation and the application periodically calling SSL
  20. functions.
  21. The OSSL_QUIC_server_method() is currently experimental and unsupported.
  22. It is provided for testing purposes. It does not provide a QUIC server
  23. implementation compliant with the QUIC specification.
  24. =head1 RETURN VALUES
  25. These functions return pointers to the constant method objects.
  26. =head1 SEE ALSO
  27. L<SSL_CTX_new_ex(3)>
  28. =head1 HISTORY
  29. OSSL_QUIC_client_method(), OSSL_QUIC_client_thread_method(), and
  30. OSSL_QUIC_server_method() were added in OpenSSL 3.1.
  31. =head1 COPYRIGHT
  32. Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
  33. Licensed under the Apache License 2.0 (the "License"). You may not use
  34. this file except in compliance with the License. You can obtain a copy
  35. in the file LICENSE in the source distribution or at
  36. L<https://www.openssl.org/source/license.html>.
  37. =cut