2011-03-11 18:14:32 -05:00
|
|
|
.\" **************************************************************************
|
|
|
|
|
.\" * _ _ ____ _
|
|
|
|
|
.\" * Project ___| | | | _ \| |
|
|
|
|
|
.\" * / __| | | | |_) | |
|
|
|
|
|
.\" * | (__| |_| | _ <| |___
|
|
|
|
|
.\" * \___|\___/|_| \_\_____|
|
|
|
|
|
.\" *
|
2013-08-09 17:27:43 -04:00
|
|
|
.\" * Copyright (C) 1998 - 2013, Daniel Stenberg, <daniel@haxx.se>, et al.
|
2011-03-11 18:14:32 -05:00
|
|
|
.\" *
|
|
|
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
|
|
|
.\" * you should have received as part of this distribution. The terms
|
|
|
|
|
.\" * are also available at http://curl.haxx.se/docs/copyright.html.
|
|
|
|
|
.\" *
|
|
|
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
|
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
|
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
|
|
|
.\" *
|
|
|
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
|
|
|
.\" * KIND, either express or implied.
|
|
|
|
|
.\" *
|
|
|
|
|
.\" **************************************************************************
|
2002-03-07 03:50:18 -05:00
|
|
|
.TH curl_multi_add_handle 3 "4 March 2002" "libcurl 7.9.5" "libcurl Manual"
|
2002-03-04 05:09:48 -05:00
|
|
|
.SH NAME
|
|
|
|
|
curl_multi_add_handle - add an easy handle to a multi session
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLMcode curl_multi_add_handle(CURLM *multi_handle, CURL *easy_handle);
|
|
|
|
|
.ad
|
|
|
|
|
.SH DESCRIPTION
|
2004-03-15 06:37:37 -05:00
|
|
|
Adds a standard easy handle to the multi stack. This function call will make
|
2013-08-09 17:27:43 -04:00
|
|
|
this \fImulti_handle\fP control the specified \fIeasy_handle\fP. Furthermore,
|
|
|
|
|
libcurl now initiates the connection associated with the specified
|
|
|
|
|
\fIeasy_handle\fP.
|
2002-03-07 03:50:18 -05:00
|
|
|
|
|
|
|
|
When an easy handle has been added to a multi stack, you can not and you must
|
2004-03-15 06:37:37 -05:00
|
|
|
not use \fIcurl_easy_perform(3)\fP on that handle!
|
2004-04-13 10:27:47 -04:00
|
|
|
|
2006-07-07 19:08:03 -04:00
|
|
|
If the easy handle is not set to use a shared (CURLOPT_SHARE) or global DNS
|
|
|
|
|
cache (CURLOPT_DNS_USE_GLOBAL_CACHE), it will be made to use the DNS cache
|
|
|
|
|
that is shared between all easy handles within the multi handle when
|
|
|
|
|
\fIcurl_multi_add_handle(3)\fP is called.
|
|
|
|
|
|
2013-08-09 17:27:43 -04:00
|
|
|
If you have CURLMOPT_TIMERFUNCTION set in the multi handle (and you really
|
2013-08-09 17:53:51 -04:00
|
|
|
should if you're working event-based with \fIcurl_multi_socket_action(3)\fP
|
|
|
|
|
and friends), that callback will be called from within this function to ask
|
|
|
|
|
for an updated timer so that your main event loop will get the activity on
|
|
|
|
|
this handle to get started.
|
2013-08-09 17:27:43 -04:00
|
|
|
|
2004-04-13 10:27:47 -04:00
|
|
|
The easy handle will remain added until you remove it again with
|
|
|
|
|
\fIcurl_multi_remove_handle(3)\fP. 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
|
2002-03-04 05:09:48 -05:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
CURLMcode type, general libcurl multi interface error code.
|
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR curl_multi_cleanup "(3)," curl_multi_init "(3)"
|
