xref: /openssl/doc/man3/SSL_get0_connection.pod (revision 1e4a9d88)
1=pod
2
3=head1 NAME
4
5SSL_get0_connection, SSL_is_connection - get a QUIC connection SSL object from a
6QUIC stream SSL object
7
8=head1 SYNOPSIS
9
10 #include <openssl/ssl.h>
11
12 SSL *SSL_get0_connection(SSL *ssl);
13 int SSL_is_connection(SSL *ssl);
14
15=head1 DESCRIPTION
16
17The SSL_get0_connection() function, when called on a QUIC stream SSL object,
18returns the QUIC connection SSL object which the QUIC stream SSL object belongs
19to.
20
21When called on a QUIC connection SSL object, it returns the same object.
22
23When called on a non-QUIC object, it returns the same object it was passed.
24
25SSL_is_connection() returns 1 for QUIC connection SSL objects and for non-QUIC
26SSL objects, but returns 0 for QUIC stream SSL objects.
27
28=head1 RETURN VALUES
29
30SSL_get0_connection() returns the QUIC connection SSL object (for a QUIC stream
31SSL object) and otherwise returns the same SSL object passed. It always returns
32non-NULL.
33
34SSL_is_connection() returns 1 if the SSL object is not a QUIC stream SSL object
35and 0 otherwise.
36
37=head1 SEE ALSO
38
39L<SSL_new(3)>, L<SSL_new_stream(3)>, L<SSL_accept_stream(3)>
40
41=head1 HISTORY
42
43These functions were added in OpenSSL 3.2.
44
45=head1 COPYRIGHT
46
47Copyright 2002-2023 The OpenSSL Project Authors. All Rights Reserved.
48
49Licensed under the Apache License 2.0 (the "License").  You may not use
50this file except in compliance with the License.  You can obtain a copy
51in the file LICENSE in the source distribution or at
52L<https://www.openssl.org/source/license.html>.
53
54=cut
55