Debian Codegraph @

upstream/debian-unstable/man3/OSSL_QUIC_client_method.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 "OSSL_QUIC_CLIENT_METHOD 3SSL"
58 .TH OSSL_QUIC_CLIENT_METHOD 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 OSSL_QUIC_client_method, OSSL_QUIC_client_thread_method, OSSL_QUIC_server_method
65 \&\- Provide SSL_METHOD objects for QUIC enabled functions
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/quic.h>
70 \&
71 \& const SSL_METHOD *OSSL_QUIC_client_method(void);
72 \& const SSL_METHOD *OSSL_QUIC_client_thread_method(void);
73 \& const SSL_METHOD *OSSL_QUIC_server_method(void);
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 The \fBOSSL_QUIC_client_method()\fR, \fBOSSL_QUIC_client_thread_method()\fR, and
78 \&\fBOSSL_QUIC_server_method()\fR functions provide methods for the
79 \&\fBSSL_CTX_new_ex\fR\|(3) function to provide QUIC protocol support.
80 .PP
81 The \fBOSSL_QUIC_client_thread_method()\fR uses threads to allow for a blocking
82 mode of operation and avoid the need to return control to the
83 OpenSSL library for processing time based events.
84 The \fBOSSL_QUIC_client_method()\fR does not use threads and depends on
85 nonblocking mode of operation and the application periodically calling SSL
86 functions.
87 .PP
88 The \fBOSSL_QUIC_server_method()\fR provides server-side QUIC protocol support and
89 must be used with the \fBSSL_new_listener\fR\|(3) API. Attempting to use
90 \&\fBOSSL_QUIC_server_method()\fR with \fBSSL_new\fR\|(3) will result in an error.
91 .SH "RETURN VALUES"
92 .IX Header "RETURN VALUES"
93 These functions return pointers to the constant method objects.
94 .SH "SEE ALSO"
95 .IX Header "SEE ALSO"
96 \&\fBSSL_CTX_new_ex\fR\|(3), \fBSSL_new_listener\fR\|(3)
97 .SH HISTORY
98 .IX Header "HISTORY"
99 \&\fBOSSL_QUIC_client_method()\fR and \fBOSSL_QUIC_client_thread_method()\fR were added in
100 OpenSSL 3.2.
101 .PP
102 \&\fBOSSL_QUIC_server_method()\fR was added in OpenSSL 3.5.
103 .SH COPYRIGHT
104 .IX Header "COPYRIGHT"
105 Copyright 2022\-2025 The OpenSSL Project Authors. All Rights Reserved.
106 .PP
107 Licensed under the Apache License 2.0 (the "License"). You may not use
108 this file except in compliance with the License. You can obtain a copy
109 in the file LICENSE in the source distribution or at
110 <https://www.openssl.org/source/license.html>.