doc/man3/OSSL_QUIC_client_method.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OSSL_QUIC_client_method, OSSL_QUIC_client_thread_method,
   6 OSSL_QUIC_server_method
   7 - Provide SSL_METHOD objects for QUIC enabled functions
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/quic.h>
  12
  13  const SSL_METHOD *OSSL_QUIC_client_method(void);
  14  const SSL_METHOD *OSSL_QUIC_client_thread_method(void);
  15  const SSL_METHOD *OSSL_QUIC_server_method(void);
  16
  17 =head1 DESCRIPTION
  18
  19 The OSSL_QUIC_client_method(), OSSL_QUIC_client_thread_method(), and
  20 OSSL_QUIC_server_method() functions provide methods for the
  21 L<SSL_CTX_new_ex(3)> function to provide QUIC protocol support.
  22
  23 The OSSL_QUIC_client_thread_method() uses threads to allow for a blocking
  24 mode of operation and avoid the need to return control to the
  25 OpenSSL library for processing time based events.
  26 The OSSL_QUIC_client_method() does not use threads and depends on
  27 nonblocking mode of operation and the application periodically calling SSL
  28 functions.
  29
  30 The OSSL_QUIC_server_method() is currently experimental and unsupported.
  31 It is provided for testing purposes. It does not provide a QUIC server
  32 implementation compliant with the QUIC specification.
  33
  34 =head1 RETURN VALUES
  35
  36 These functions return pointers to the constant method objects.
  37
  38 =head1 SEE ALSO
  39
  40 L<SSL_CTX_new_ex(3)>
  41
  42 =head1 HISTORY
  43
  44 OSSL_QUIC_client_method(), OSSL_QUIC_client_thread_method(), and
  45 OSSL_QUIC_server_method() were added in OpenSSL 3.1.
  46
  47 =head1 COPYRIGHT
  48
  49 Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
  50
  51 Licensed under the Apache License 2.0 (the "License").  You may not use
  52 this file except in compliance with the License.  You can obtain a copy
  53 in the file LICENSE in the source distribution or at
  54 L<https://www.openssl.org/source/license.html>.
  55
  56 =cut