diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/SSL_get0_connection.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/SSL_get0_connection.3 | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/secure/lib/libcrypto/man/man3/SSL_get0_connection.3 b/secure/lib/libcrypto/man/man3/SSL_get0_connection.3 new file mode 100644 index 000000000000..54737056af2d --- /dev/null +++ b/secure/lib/libcrypto/man/man3/SSL_get0_connection.3 @@ -0,0 +1,107 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "SSL_GET0_CONNECTION 3ossl" +.TH SSL_GET0_CONNECTION 3ossl 2025-09-30 3.5.4 OpenSSL +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH NAME +SSL_get0_connection, SSL_is_connection \- get a QUIC connection SSL object from a +QUIC stream SSL object +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 1 +\& #include <openssl/ssl.h> +\& +\& SSL *SSL_get0_connection(SSL *ssl); +\& int SSL_is_connection(SSL *ssl); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +The \fBSSL_get0_connection()\fR function, when called on a QUIC stream SSL object, +returns the QUIC connection SSL object which the QUIC stream SSL object belongs +to. +.PP +When called on a QUIC connection SSL object, it returns the same object. +.PP +When called on a non-QUIC object, it returns the same object it was passed. +.PP +\&\fBSSL_is_connection()\fR returns 1 for QUIC connection SSL objects and for non-QUIC +SSL objects, but returns 0 for QUIC stream SSL objects. +.SH "RETURN VALUES" +.IX Header "RETURN VALUES" +\&\fBSSL_get0_connection()\fR returns the QUIC connection SSL object (for a QUIC stream +SSL object) and otherwise returns the same SSL object passed. It always returns +non-NULL. +.PP +\&\fBSSL_is_connection()\fR returns 1 if the SSL object is not a QUIC stream SSL object +and 0 otherwise. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fBSSL_new\fR\|(3), \fBSSL_new_stream\fR\|(3), \fBSSL_accept_stream\fR\|(3) +.SH HISTORY +.IX Header "HISTORY" +These functions were added in OpenSSL 3.2. +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright 2002\-2023 The OpenSSL Project Authors. All Rights Reserved. +.PP +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +<https://www.openssl.org/source/license.html>. |