curl/curl
1
1
Fork 0
mirror of https://github.com/curl/curl.git synced 2025-09-19 10:32:44 +03:00
Code Issues Packages Projects Releases Wiki Activity

curl_global_sslset.3: clarify

Browse Source 
it is a one time *set*, not necessarily a one time use... it can be
called again if the first call failed or just listed the alternatives.

clarify that the available backends are the ones this build supports

plus add some formatting

Reported-by: Rich Gray
Bug: https://curl.haxx.se/mail/lib-2017-08/0119.html
This commit is contained in:
Daniel Stenberg 2017-08-30 09:48:14 +02:00
parent 73fa6aa00a
commit 860443bee4
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
1 changed files with 19 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/libcurl/curl_global_sslset.3
View File

@ -29,25 +29,29 @@ curl_global_sslset - Select SSL backend to use with libcurl
.BI ", curl_ssl_backend ***" avail ");" .BI ", curl_ssl_backend ***" avail ");"
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
This function configures at runtime which SSL backend to use with libcurl. This This function configures at runtime which SSL backend to use with
function can only be called once, and it must be called \fBbefore\fP libcurl. This function can only be used to select an SSL backend once, and it
curl_global_init(). must be called \fBbefore\fP \fIcurl_global_init(3)\fP.
The backend can be identified by the id (e.g. CURLSSLBACKEND_OPENSSL). The The backend can be identified by the \fIid\fP
backend can also be specified via the name parameter (passing -1 as id). (e.g. \fBCURLSSLBACKEND_OPENSSL\fP). The backend can also be specified via the
If both id and name are specified, the name will be ignored. If neither id \fIname\fP parameter (passing -1 as \fIid\fP). If both \fIid\fP and \fIname\fP
nor name are specified, the function will fail with are specified, the \fIname\fP will be ignored.
CURLSSLSET_UNKNOWN_BACKEND and set the "avail" pointer to the
NULL-terminated list of available backends. If neither \fIid\fP nor \fPname\fP are specified, the function will fail with
CURLSSLSET_UNKNOWN_BACKEND and set the \fIavail\fP pointer to the
NULL-terminated list of available backends. The available backends are those
that this particular build of libcurl supports.
Upon success, the function returns CURLSSLSET_OK. Upon success, the function returns CURLSSLSET_OK.
If the specified SSL backend is not available, the function returns If the specified SSL backend is not available, the function returns
CURLSSLSET_UNKNOWN_BACKEND and sets the "avail" pointer to a NULL-terminated CURLSSLSET_UNKNOWN_BACKEND and sets the \fIavail\fP pointer to a
list of available SSL backends. NULL-terminated list of available SSL backends. In this case, you may call the
function again to try to select a different backend.
The SSL backend can be set only once. If it has already been set, a The SSL backend can be set only once. If it has already been set, a subsequent
subsequent attempt to change it will result in a CURLSSLSET_TOO_LATE. attempt to change it will result in a \fBCURLSSLSET_TOO_LATE\fP.
\fBThis function is not thread safe.\fP You must not call it when any other \fBThis function is not thread safe.\fP You must not call it when any other
thread in the program (i.e. a thread sharing the same memory) is running. thread in the program (i.e. a thread sharing the same memory) is running.
@ -62,8 +66,8 @@ If this function returns CURLSSLSET_OK, the backend was successfully selected.
If the chosen backend is unknown (or support for the chosed backend has not If the chosen backend is unknown (or support for the chosed backend has not
been compiled into libcurl), the function returns CURLSSLSET_UNKNOWN_BACKEND. been compiled into libcurl), the function returns CURLSSLSET_UNKNOWN_BACKEND.
If the backend had been configured previously, or if curl_global_init() has If the backend had been configured previously, or if \fIcurl_global_init(3)\fP
already been called, the function returns CURLSSLSET_TOO_LATE. has already been called, the function returns CURLSSLSET_TOO_LATE.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR curl_global_init "(3), " .BR curl_global_init "(3), "
.BR libcurl "(3) " .BR libcurl "(3) "