| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273 |
- .\" generated by cd2nroff 0.1 from curl_multi_add_handle.md
- .TH curl_multi_add_handle 3 "2025-01-17" libcurl
- .SH NAME
- curl_multi_add_handle \- add an easy handle to a multi session
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLMcode curl_multi_add_handle(CURLM *multi_handle, CURL *easy_handle);
- .fi
- .SH DESCRIPTION
- Adds the \fIeasy handle\fP to the \fImulti_handle\fP.
- While an easy handle is added to a multi stack, you cannot and you must not
- use \fIcurl_easy_perform(3)\fP on that handle. After having removed the easy
- handle from the multi stack again, it is perfectly fine to use it with the
- easy interface again.
- If the easy handle is not set to use a shared (\fICURLOPT_SHARE(3)\fP) cache,
- it is made to use a DNS cache that is shared between all easy handles within
- the multi handle when \fIcurl_multi_add_handle(3)\fP is called.
- When an easy interface is added to a multi handle, it is set to use a shared
- connection cache owned by the multi handle. Removing and adding new easy
- handles does not affect the pool of connections or the ability to do
- connection reuse.
- If you have \fICURLMOPT_TIMERFUNCTION(3)\fP set in the multi handle (as you
- should if you are working event\-based with \fIcurl_multi_socket_action(3)\fP
- and friends), that callback is called from within this function to ask for an
- updated timer so that your main event loop gets the activity on this handle to
- get started.
- The easy handle remains added to the multi handle until you remove it again
- with \fIcurl_multi_remove_handle(3)\fP \- even when a transfer with that
- specific easy handle is completed.
- You should remove the easy handle from the multi stack before you terminate
- first the easy handle and then the multi handle:
- 1 \- \fIcurl_multi_remove_handle(3)\fP
- 2 \- \fIcurl_easy_cleanup(3)\fP
- 3 \- \fIcurl_multi_cleanup(3)\fP
- .SH PROTOCOLS
- This functionality affects all supported protocols
- .SH EXAMPLE
- .nf
- int main(void)
- {
- /* init a multi stack */
- CURLM *multi = curl_multi_init();
- /* create two easy handles */
- CURL *http_handle = curl_easy_init();
- CURL *http_handle2 = curl_easy_init();
- /* add individual transfers */
- curl_multi_add_handle(multi, http_handle);
- curl_multi_add_handle(multi, http_handle2);
- }
- .fi
- .SH AVAILABILITY
- Added in curl 7.9.6
- .SH RETURN VALUE
- CURLMcode type, general libcurl multi interface error code.
- .SH SEE ALSO
- .BR curl_multi_cleanup (3),
- .BR curl_multi_get_handles (3),
- .BR curl_multi_init (3),
- .BR curl_multi_setopt (3),
- .BR curl_multi_socket_action (3)
|