Mercurial > hgrepos > Python2 > PyMuPDF

comparison mupdf-source/thirdparty/curl/docs/libcurl/curl_global_sslset.3 @ 2:b50eed0cc0ef upstream

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .TH curl_global_sslset 3 "15 July 2017" "libcurl 7.56" "libcurl Manual"
23 .SH NAME
24 curl_global_sslset - Select SSL backend to use with libcurl
25 .SH SYNOPSIS
26 .B #include <curl/curl.h>
27 .nf
28
29 typedef struct {
30 curl_sslbackend id;
31 const char *name;
32 } curl_ssl_backend;
33
34 typedef enum {
35 CURLSSLBACKEND_NONE = 0,
36 CURLSSLBACKEND_OPENSSL = 1,
37 CURLSSLBACKEND_GNUTLS = 2,
38 CURLSSLBACKEND_NSS = 3,
39 CURLSSLBACKEND_GSKIT = 5,
40 CURLSSLBACKEND_POLARSSL = 6,
41 CURLSSLBACKEND_WOLFSSL = 7,
42 CURLSSLBACKEND_SCHANNEL = 8,
43 CURLSSLBACKEND_DARWINSSL = 9,
44 CURLSSLBACKEND_AXTLS = 10, /* deprecated */
45 CURLSSLBACKEND_MBEDTLS = 11,
46 CURLSSLBACKEND_MESALINK = 12
47 } curl_sslbackend;
48
49 .B "CURLsslset curl_global_sslset(curl_sslbackend " id,
50 .B " const char *" name,
51 .B " curl_ssl_backend ***" avail ");"
52 .fi
53 .SH DESCRIPTION
54 This function configures at runtime which SSL backend to use with
55 libcurl. This function can only be used to select an SSL backend once, and it
56 must be called \fBbefore\fP \fIcurl_global_init(3)\fP.
57
58 The backend can be identified by the \fIid\fP
59 (e.g. \fBCURLSSLBACKEND_OPENSSL\fP). The backend can also be specified via the
60 \fIname\fP parameter for a case insensitive match (passing -1 as \fIid\fP). If
61 both \fIid\fP and \fIname\fP are specified, the \fIname\fP will be ignored.
62
63 If neither \fIid\fP nor \fPname\fP are specified, the function will fail with
64 CURLSSLSET_UNKNOWN_BACKEND and set the \fIavail\fP pointer to the
65 NULL-terminated list of available backends. The available backends are those
66 that this particular build of libcurl supports.
67
68 Since libcurl 7.60.0, the \fIavail\fP pointer will always be set to the list
69 of alternatives if non-NULL.
70
71 Upon success, the function returns CURLSSLSET_OK.
72
73 If the specified SSL backend is not available, the function returns
74 CURLSSLSET_UNKNOWN_BACKEND and sets the \fIavail\fP pointer to a
75 NULL-terminated list of available SSL backends. In this case, you may call the
76 function again to try to select a different backend.
77
78 The SSL backend can be set only once. If it has already been set, a subsequent
79 attempt to change it will result in a \fBCURLSSLSET_TOO_LATE\fP.
80
81 \fBThis function is not thread safe.\fP You must not call it when any other
82 thread in the program (i.e. a thread sharing the same memory) is running.
83 This doesn't just mean no other thread that is using libcurl.
84
85 .SH AVAILABILITY
86 This function was added in libcurl 7.56.0. Before this version, there was no
87 support for choosing SSL backends at runtime.
88 .SH RETURN VALUE
89 If this function returns CURLSSLSET_OK, the backend was successfully selected.
90
91 If the chosen backend is unknown (or support for the chosen backend has not
92 been compiled into libcurl), the function returns \fICURLSSLSET_UNKNOWN_BACKEND\fP.
93
94 If the backend had been configured previously, or if \fIcurl_global_init(3)\fP
95 has already been called, the function returns \fICURLSSLSET_TOO_LATE\fP.
96
97 If this libcurl was built completely without SSL support, with no backends at
98 all, this function returns \fICURLSSLSET_NO_BACKENDS\fP.
99 .SH "SEE ALSO"
100 .BR curl_global_init "(3), "
101 .BR libcurl "(3) "