docs/libcurl/curl_multi_add_handle.3

   1 .\"
   2 .TH curl_multi_add_handle 3 "4 March 2002" "libcurl 7.9.5" "libcurl Manual"
   3 .SH NAME
   4 curl_multi_add_handle - add an easy handle to a multi session
   5 .SH SYNOPSIS
   6 #include <curl/curl.h>
   7
   8 CURLMcode curl_multi_add_handle(CURLM *multi_handle, CURL *easy_handle);
   9 .ad
  10 .SH DESCRIPTION
  11 Adds a standard easy handle to the multi stack. This function call will make
  12 this \fImulti_handle\fP control the specified \fIeasy_handle\fP.
  13 Furthermore, libcurl now initiates the connection associated with the
  14 specified \fIeasy_handle\fP.
  15
  16 When an easy handle has been added to a multi stack, you can not and you must
  17 not use \fIcurl_easy_perform(3)\fP on that handle!
  18
  19 If the easy handle is not set to use a shared (CURLOPT_SHARE) or global DNS
  20 cache (CURLOPT_DNS_USE_GLOBAL_CACHE), it will be made to use the DNS cache
  21 that is shared between all easy handles within the multi handle when
  22 \fIcurl_multi_add_handle(3)\fP is called.
  23
  24 The easy handle will remain added until you remove it again with
  25 \fIcurl_multi_remove_handle(3)\fP. You should remove the easy handle from the
  26 multi stack before you terminate first the easy handle and then the multi
  27 handle:
  28
  29 1 - \fIcurl_multi_remove_handle(3)\fP
  30
  31 2 - \fIcurl_easy_cleanup(3)\fP
  32
  33 3 - \fIcurl_multi_cleanup(3)\fP
  34 .SH RETURN VALUE
  35 CURLMcode type, general libcurl multi interface error code.
  36 .SH "SEE ALSO"
  37 .BR curl_multi_cleanup "(3)," curl_multi_init "(3)"