curl/docs/libcurl/curl_multi_add_handle.3

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