Debian Codegraph @

upstream/debian-unstable/man3/SSL_get0_connection.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SSL_GET0_CONNECTION 3SSL"
58 .TH SSL_GET0_CONNECTION 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SSL_get0_connection, SSL_is_connection \- get a QUIC connection SSL object from a
65 QUIC stream SSL object
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/ssl.h>
70 \&
71 \& SSL *SSL_get0_connection(SSL *ssl);
72 \& int SSL_is_connection(SSL *ssl);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 The \fBSSL_get0_connection()\fR function, when called on a QUIC stream SSL object,
77 returns the QUIC connection SSL object which the QUIC stream SSL object belongs
78 to.
79 .PP
80 When called on a QUIC connection SSL object, it returns the same object.
81 .PP
82 When called on a non-QUIC object, it returns the same object it was passed.
83 .PP
84 \&\fBSSL_is_connection()\fR returns 1 for QUIC connection SSL objects and for non-QUIC
85 SSL objects, but returns 0 for QUIC stream SSL objects.
86 .SH "RETURN VALUES"
87 .IX Header "RETURN VALUES"
88 \&\fBSSL_get0_connection()\fR returns the QUIC connection SSL object (for a QUIC stream
89 SSL object) and otherwise returns the same SSL object passed. It always returns
90 non-NULL.
91 .PP
92 \&\fBSSL_is_connection()\fR returns 1 if the SSL object is not a QUIC stream SSL object
93 and 0 otherwise.
94 .SH "SEE ALSO"
95 .IX Header "SEE ALSO"
96 \&\fBSSL_new\fR\|(3), \fBSSL_new_stream\fR\|(3), \fBSSL_accept_stream\fR\|(3)
97 .SH HISTORY
98 .IX Header "HISTORY"
99 These functions were added in OpenSSL 3.2.
100 .SH COPYRIGHT
101 .IX Header "COPYRIGHT"
102 Copyright 2002\-2023 The OpenSSL Project Authors. All Rights Reserved.
103 .PP
104 Licensed under the Apache License 2.0 (the "License"). You may not use
105 this file except in compliance with the License. You can obtain a copy
106 in the file LICENSE in the source distribution or at
107 <https://www.openssl.org/source/license.html>.