openssl/doc/man3/OSSL_QUIC_client_method.pod
Richard Levitte 45ada6b92b Change all references to OpenSSL 3.1 to OpenSSL 3.2 in the master branch
3.1 has been decided to be a FIPS 140-3 release, springing from the branch
openssl-3.0, and the master branch to continue with the development of
OpenSSL 3.2.

Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
Reviewed-by: Tim Hudson <tjh@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/19350)
2022-10-07 10:05:50 +02:00

57 lines
1.7 KiB
Plaintext

=pod
=head1 NAME
OSSL_QUIC_client_method, OSSL_QUIC_client_thread_method,
OSSL_QUIC_server_method
- Provide SSL_METHOD objects for QUIC enabled functions
=head1 SYNOPSIS
#include <openssl/quic.h>
const SSL_METHOD *OSSL_QUIC_client_method(void);
const SSL_METHOD *OSSL_QUIC_client_thread_method(void);
const SSL_METHOD *OSSL_QUIC_server_method(void);
=head1 DESCRIPTION
The OSSL_QUIC_client_method(), OSSL_QUIC_client_thread_method(), and
OSSL_QUIC_server_method() functions provide methods for the
L<SSL_CTX_new_ex(3)> function to provide QUIC protocol support.
The OSSL_QUIC_client_thread_method() uses threads to allow for a blocking
mode of operation and avoid the need to return control to the
OpenSSL library for processing time based events.
The OSSL_QUIC_client_method() does not use threads and depends on
nonblocking mode of operation and the application periodically calling SSL
functions.
The OSSL_QUIC_server_method() is currently experimental and unsupported.
It is provided for testing purposes. It does not provide a QUIC server
implementation compliant with the QUIC specification.
=head1 RETURN VALUES
These functions return pointers to the constant method objects.
=head1 SEE ALSO
L<SSL_CTX_new_ex(3)>
=head1 HISTORY
OSSL_QUIC_client_method(), OSSL_QUIC_client_thread_method(), and
OSSL_QUIC_server_method() were added in OpenSSL 3.2.
=head1 COPYRIGHT
Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
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
L<https://www.openssl.org/source/license.html>.
=cut