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

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_multi_add_handle 3 "4 March 2002" "libcurl 7.9.5" "libcurl Manual"
23 .SH NAME
24 curl_multi_add_handle - add an easy handle to a multi session
25 .SH SYNOPSIS
26 #include <curl/curl.h>
27
28 CURLMcode curl_multi_add_handle(CURLM *multi_handle, CURL *easy_handle);
29 .ad
30 .SH DESCRIPTION
31 Adds a standard easy handle to the multi stack. This function call will make
32 this \fImulti_handle\fP control the specified \fIeasy_handle\fP.
33
34 While an easy handle is added to a multi stack, you cannot and you must not
35 use \fIcurl_easy_perform(3)\fP on that handle. After having removed the easy
36 handle from the multi stack again, it is perfectly fine to use it with the
37 easy interface again.
38
39 If the easy handle is not set to use a shared (\fICURLOPT_SHARE(3)\fP) or
40 global DNS cache (\fICURLOPT_DNS_USE_GLOBAL_CACHE(3)\fP), it will be made to
41 use the DNS cache that is shared between all easy handles within the multi
42 handle when \fIcurl_multi_add_handle(3)\fP is called.
43
44 When an easy interface is added to a multi handle, it will use a shared
45 connection cache owned by the multi handle. Removing and adding new easy
46 handles will not affect the pool of connections or the ability to do
47 connection re-use.
48
49 If you have \fICURLMOPT_TIMERFUNCTION(3)\fP set in the multi handle (and you
50 really should if you're working event-based with
51 \fIcurl_multi_socket_action(3)\fP and friends), that callback will be called
52 from within this function to ask for an updated timer so that your main event
53 loop will get the activity on this handle to get started.
54
55 The easy handle will remain added to the multi handle until you remove it
56 again with \fIcurl_multi_remove_handle(3)\fP - even when a transfer with that
57 specific easy handle is completed.
58
59 You should remove the easy handle from the multi stack before you terminate
60 first the easy handle and then the multi handle:
61
62 1 - \fIcurl_multi_remove_handle(3)\fP
63
64 2 - \fIcurl_easy_cleanup(3)\fP
65
66 3 - \fIcurl_multi_cleanup(3)\fP
67 .SH RETURN VALUE
68 CURLMcode type, general libcurl multi interface error code.
69 .SH "SEE ALSO"
70 .BR curl_multi_cleanup "(3)," curl_multi_init "(3), "
71 .BR curl_multi_setopt "(3), " curl_multi_socket_action "(3) "