SSL_get0_connection.pod 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. =pod
  2. =head1 NAME
  3. SSL_get0_connection, SSL_is_connection - get a QUIC connection SSL object from a
  4. QUIC stream SSL object
  5. =head1 SYNOPSIS
  6. #include <openssl/ssl.h>
  7. SSL *SSL_get0_connection(SSL *ssl);
  8. int SSL_is_connection(SSL *ssl);
  9. =head1 DESCRIPTION
  10. The SSL_get0_connection() function, when called on a QUIC stream SSL object,
  11. returns the QUIC connection SSL object which the QUIC stream SSL object belongs
  12. to.
  13. When called on a QUIC connection SSL object, it returns the same object.
  14. When called on a non-QUIC object, it returns the same object it was passed.
  15. SSL_is_connection() returns 1 for QUIC connection SSL objects and for non-QUIC
  16. SSL objects, but returns 0 for QUIC stream SSL objects.
  17. =head1 RETURN VALUES
  18. SSL_get0_connection() returns the QUIC connection SSL object (for a QUIC stream
  19. SSL object) and otherwise returns the same SSL object passed. It always returns
  20. non-NULL.
  21. SSL_is_connection() returns 1 if the SSL object is not a QUIC stream SSL object
  22. and 0 otherwise.
  23. =head1 SEE ALSO
  24. L<SSL_new(3)>, L<SSL_new_stream(3)>, L<SSL_accept_stream(3)>
  25. =head1 HISTORY
  26. These functions were added in OpenSSL 3.2.
  27. =head1 COPYRIGHT
  28. Copyright 2002-2023 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