docs/libcurl/curl_multi_setopt.3

   1 .\" $Id$
   2 .\"
   3 .TH curl_multi_setopt 3 "10 Oct 2006" "libcurl 7.16.0" "libcurl Manual"
   4 .SH NAME
   5 curl_multi_setopt \- set options for a curl multi handle
   6 .SH SYNOPSIS
   7 #include <curl/curl.h>
   8
   9 CURLMcode curl_multi_setopt(CURLM * multi_handle, CURLMoption option, param);
  10 .SH DESCRIPTION
  11 curl_multi_setopt() is used to tell a libcurl multi handle how to behave. By
  12 using the appropriate options to \fIcurl_multi_setopt(3)\fP, you can change
  13 libcurl's behaviour when using that multi handle.  All options are set with
  14 the \fIoption\fP followed by the parameter \fIparam\fP. That parameter can be
  15 a \fBlong\fP, a \fBfunction pointer\fP, an \fBobject pointer\fP or a
  16 \fBcurl_off_t\fP type, depending on what the specific option expects. Read
  17 this manual carefully as bad input values may cause libcurl to behave badly!
  18 You can only set one option in each function call.
  19
  20 .SH OPTIONS
  21 .IP CURLMOPT_SOCKETFUNCTION
  22 Pass a pointer to a function matching the \fBcurl_socket_callback\fP
  23 prototype. The \fIcurl_multi_socket(3)\fP functions inform the application
  24 about updates in the socket (file descriptor) status by doing none, one, or
  25 multiple calls to the curl_socket_callback given in the \fBparam\fP
  26 argument. They update the status with changes since the previous time a
  27 \fIcurl_multi_socket(3)\fP function was called. If the given callback pointer
  28 is NULL, no callback will be called. Set the callback's \fBuserp\fP argument
  29 with \fICURLMOPT_SOCKETDATA\fP.  See \fIcurl_multi_socket(3)\fP for more
  30 callback details.
  31 .IP CURLMOPT_SOCKETDATA
  32 Pass a pointer to whatever you want passed to the \fBcurl_socket_callback\fP's
  33 forth argument, the userp pointer. This is not used by libcurl but only
  34 passed-thru as-is. Set the callback pointer with
  35 \fICURLMOPT_SOCKETFUNCTION\fP.
  36 .IP CURLMOPT_PIPELINING
  37 Pass a long set to 1 to enable or 0 to disable. Enabling pipelining on a multi
  38 handle will make it attempt to perform HTTP Pipelining as far as possible for
  39 transfers using this handle. This means that if you add a second request that
  40 can use an already existing connection, the second request will be \&"piped"
  41 on the same connection rather than being executed in parallel. (Added in
  42 7.16.0)
  43 .IP CURLMOPT_TIMERFUNCTION
  44 Pass a pointer to a function matching the \fBcurl_multi_timer_callback\fP
  45 prototype.  This function will then be called when the timeout value
  46 changes. The timeout value is at what latest time the application should call
  47 one of the \&"performing" functions of the multi interface
  48 (\fIcurl_multi_socket(3)\fP, \fIcurl_multi_socket_all(3)\fP and
  49 \fIcurl_multi_perform(3)\fP) - to allow libcurl to keep timeouts and retries
  50 etc to work. A timeout value of -1 means that there is no timeout at all, and
  51 0 means that the timeout is already reached. Libcurl attempts to limit calling
  52 this only when the fixed future timeout time actually changes. See also
  53 \fICURLMOPT_TIMERDATA\fP. This callback can be used instead of, or in addition
  54 to, \fIcurl_multi_timeout(3)\fP. (Added in 7.16.0)
  55 .IP CURLMOPT_TIMERDATA
  56 Pass a pointer to whatever you want passed to the
  57 \fBcurl_multi_timer_callback\fP's third argument, the userp pointer.  This is
  58 not used by libcurl but only passed-thru as-is. Set the callback pointer with
  59 \fICURLMOPT_TIMERFUNCTION\fP. (Added in 7.16.0)
  60 .IP CURLMOPT_MAXCONNECTS
  61 Pass a long. The set number will be used as the maximum amount of
  62 simultaneously open connections that libcurl may cache. Default is 10, and
  63 libcurl will enlarge the size for each added easy handle to make it fit 4
  64 times the number of added easy handles.
  65
  66 By setting this option, you can prevent the cache size from growing beyond the
  67 limit set by you.
  68
  69 When the cache is full, curl closes the oldest one in the cache to prevent the
  70 number of open connections from increasing.
  71
  72 This option is for the multi handle's use only, when using the easy interface
  73 you should instead use the \fICURLOPT_MAXCONNECTS\fP option.
  74
  75 (Added in 7.16.3)
  76 .SH RETURNS
  77 The standard CURLMcode for multi interface error codes. Note that it returns a
  78 CURLM_UNKNOWN_OPTION if you try setting an option that this version of libcurl
  79 doesn't know of.
  80 .SH AVAILABILITY
  81 This function was added in libcurl 7.15.4.
  82 .SH "SEE ALSO"
  83 .BR curl_multi_cleanup "(3), " curl_multi_init "(3), "
  84 .BR curl_multi_socket "(3), " curl_multi_info_read "(3)"