docs/libcurl/curl_multi_add_handle.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2013, 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 http://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.  Furthermore,
  33 libcurl now initiates the connection associated with the specified
  34 \fIeasy_handle\fP.
  35
  36 When an easy handle has been added to a multi stack, you can not and you must
  37 not use \fIcurl_easy_perform(3)\fP on that handle!
  38
  39 If the easy handle is not set to use a shared (CURLOPT_SHARE) or global DNS
  40 cache (CURLOPT_DNS_USE_GLOBAL_CACHE), it will be made to use the DNS cache
  41 that is shared between all easy handles within the multi handle when
  42 \fIcurl_multi_add_handle(3)\fP is called.
  43
  44 If you have CURLMOPT_TIMERFUNCTION set in the multi handle (and you really
  45 should if you're working event-based with \fIcurl_multi_socket_action(3)\fP
  46 and friends), that callback will be called from within this function to ask
  47 for an updated timer so that your main event loop will get the activity on
  48 this handle to get started.
  49
  50 The easy handle will remain added until you remove it again with
  51 \fIcurl_multi_remove_handle(3)\fP. You should remove the easy handle from the
  52 multi stack before you terminate first the easy handle and then the multi
  53 handle:
  54
  55 1 - \fIcurl_multi_remove_handle(3)\fP
  56
  57 2 - \fIcurl_easy_cleanup(3)\fP
  58
  59 3 - \fIcurl_multi_cleanup(3)\fP
  60 .SH RETURN VALUE
  61 CURLMcode type, general libcurl multi interface error code.
  62 .SH "SEE ALSO"
  63 .BR curl_multi_cleanup "(3)," curl_multi_init "(3)"