From: Daniel Stenberg Date: Tue, 1 Oct 2024 13:01:52 +0000 (+0200) Subject: docs/libcurl: expand multi documentation X-Git-Tag: curl-8_11_0~279 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=85a81d2789186b29572928b9eab841beb7592ef7;p=thirdparty%2Fcurl.git docs/libcurl: expand multi documentation curl_multi_init - mention the caches held by the handle curl_multi_cleanup - mention that the socket callback might be invoked by this function Closes #15109 --- diff --git a/docs/libcurl/curl_multi_cleanup.md b/docs/libcurl/curl_multi_cleanup.md index fb56e6468f..21661ea8a1 100644 --- a/docs/libcurl/curl_multi_cleanup.md +++ b/docs/libcurl/curl_multi_cleanup.md @@ -41,6 +41,10 @@ handle is no longer connected to the multi handle 3 - curl_multi_cleanup(3) should be called when all easy handles are removed +When this function is called, remaining entries in the connection pool held by +the multi handle are shut down, which might trigger calls to the +CURLMOPT_SOCKETFUNCTION(3) callback. + Passing in a NULL pointer in *multi_handle* makes this function return CURLM_BAD_HANDLE immediately with no other action. diff --git a/docs/libcurl/curl_multi_init.md b/docs/libcurl/curl_multi_init.md index 7c3dac8431..28c3d69c6b 100644 --- a/docs/libcurl/curl_multi_init.md +++ b/docs/libcurl/curl_multi_init.md @@ -34,6 +34,10 @@ all the other multi-functions, sometimes referred to as a multi handle in some places in the documentation. This init call MUST have a corresponding call to curl_multi_cleanup(3) when the operation is complete. +By default, several caches are stored in and held by the multi handle: DNS +cache, connection pool, TLS session ID cache and the TLS CA cert cache. All +transfers using the same multi handle share these caches. + # %PROTOCOLS% # EXAMPLE