| Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 1 | .\" ************************************************************************** |
| 2 | .\" * _ _ ____ _ |
| 3 | .\" * Project ___| | | | _ \| | |
| 4 | .\" * / __| | | | |_) | | |
| 5 | .\" * | (__| |_| | _ <| |___ |
| 6 | .\" * \___|\___/|_| \_\_____| |
| 7 | .\" * |
| 8 | .\" * Copyright (C) 1998 - 2014, 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_setopt 3 "4 Nov 2014" "libcurl 7.39.0" "libcurl Manual" |
| Lucas Eckels | 9bd90e6 | 2012-08-06 15:07:02 -0700 | [diff] [blame] | 23 | .SH NAME |
| 24 | curl_multi_setopt \- set options for a curl multi handle |
| 25 | .SH SYNOPSIS |
| 26 | #include <curl/curl.h> |
| 27 | |
| 28 | CURLMcode curl_multi_setopt(CURLM * multi_handle, CURLMoption option, param); |
| 29 | .SH DESCRIPTION |
| Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 30 | \fIcurl_multi_setopt(3)\fP is used to tell a libcurl multi handle how to |
| 31 | behave. By using the appropriate options to \fIcurl_multi_setopt(3)\fP, you |
| 32 | can change libcurl's behaviour when using that multi handle. All options are |
| 33 | set with the \fIoption\fP followed by the parameter \fIparam\fP. That |
| 34 | parameter can be a \fBlong\fP, a \fBfunction pointer\fP, an \fBobject |
| 35 | pointer\fP or a \fBcurl_off_t\fP type, depending on what the specific option |
| 36 | expects. Read this manual carefully as bad input values may cause libcurl to |
| 37 | behave badly! You can only set one option in each function call. |
| Lucas Eckels | 9bd90e6 | 2012-08-06 15:07:02 -0700 | [diff] [blame] | 38 | |
| 39 | .SH OPTIONS |
| 40 | .IP CURLMOPT_SOCKETFUNCTION |
| Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 41 | See \fICURLMOPT_SOCKETFUNCTION(3)\fP |
| Lucas Eckels | 9bd90e6 | 2012-08-06 15:07:02 -0700 | [diff] [blame] | 42 | .IP CURLMOPT_SOCKETDATA |
| Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 43 | See \fICURLMOPT_SOCKETDATA(3)\fP |
| Lucas Eckels | 9bd90e6 | 2012-08-06 15:07:02 -0700 | [diff] [blame] | 44 | .IP CURLMOPT_PIPELINING |
| Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 45 | See \fICURLMOPT_PIPELINING(3)\fP |
| Lucas Eckels | 9bd90e6 | 2012-08-06 15:07:02 -0700 | [diff] [blame] | 46 | .IP CURLMOPT_TIMERFUNCTION |
| Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 47 | See \fICURLMOPT_TIMERFUNCTION(3)\fP |
| Lucas Eckels | 9bd90e6 | 2012-08-06 15:07:02 -0700 | [diff] [blame] | 48 | .IP CURLMOPT_TIMERDATA |
| Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 49 | See \fICURLMOPT_TIMERDATA(3)\fP |
| Lucas Eckels | 9bd90e6 | 2012-08-06 15:07:02 -0700 | [diff] [blame] | 50 | .IP CURLMOPT_MAXCONNECTS |
| Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 51 | See \fICURLMOPT_MAXCONNECTS(3)\fP |
| 52 | .IP CURLMOPT_MAX_HOST_CONNECTIONS |
| 53 | See \fICURLMOPT_MAX_HOST_CONNECTIONS(3)\fP |
| 54 | .IP CURLMOPT_MAX_PIPELINE_LENGTH |
| 55 | See \fICURLMOPT_MAX_PIPELINE_LENGTH(3)\fP |
| 56 | .IP CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE |
| 57 | See \fICURLMOPT_CONTENT_LENGTH_PENALTY_SIZE(3)\fP |
| 58 | .IP CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE |
| 59 | See \fICURLMOPT_CHUNK_LENGTH_PENALTY_SIZE(3)\fP |
| 60 | .IP CURLMOPT_PIPELINING_SITE_BL |
| 61 | See \fICURLMOPT_PIPELINING_SITE_BL(3)\fP |
| 62 | .IP CURLMOPT_PIPELINING_SERVER_BL |
| 63 | See \fICURLMOPT_PIPELINING_SERVER_BL(3)\fP |
| 64 | .IP CURLMOPT_MAX_TOTAL_CONNECTIONS |
| 65 | See \fICURLMOPT_MAX_TOTAL_CONNECTIONS(3)\fP |
| Lucas Eckels | 9bd90e6 | 2012-08-06 15:07:02 -0700 | [diff] [blame] | 66 | .SH RETURNS |
| 67 | The standard CURLMcode for multi interface error codes. Note that it returns a |
| 68 | CURLM_UNKNOWN_OPTION if you try setting an option that this version of libcurl |
| 69 | doesn't know of. |
| 70 | .SH AVAILABILITY |
| 71 | This function was added in libcurl 7.15.4. |
| 72 | .SH "SEE ALSO" |
| 73 | .BR curl_multi_cleanup "(3), " curl_multi_init "(3), " |
| 74 | .BR curl_multi_socket "(3), " curl_multi_info_read "(3)" |