| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * Project ___| | | | _ \| |
- .\" * / __| | | | |_) | |
- .\" * | (__| |_| | _ <| |___
- .\" * \___|\___/|_| \_\_____|
- .\" *
- .\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
- .\" *
- .\" * 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 https://curl.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.
- .\" *
- .\" * SPDX-License-Identifier: curl
- .\" *
- .\" **************************************************************************
- .TH curl_multi_setopt 3 "4 Nov 2014" "libcurl" "libcurl"
- .SH NAME
- curl_multi_setopt \- set options for a curl multi handle
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLMcode curl_multi_setopt(CURLM *multi_handle, CURLMoption option, param);
- .fi
- .SH DESCRIPTION
- \fIcurl_multi_setopt(3)\fP is used to tell a libcurl multi handle how to
- behave. By using the appropriate options to \fIcurl_multi_setopt(3)\fP, you
- can change libcurl's behavior when using that multi handle. All options are
- set with the \fIoption\fP followed by the parameter \fIparam\fP. That
- parameter can be a \fBlong\fP, a \fBfunction pointer\fP, an \fBobject
- pointer\fP or a \fBcurl_off_t\fP type, depending on what the specific option
- expects. Read this manual carefully as bad input values may cause libcurl to
- behave badly. You can only set one option in each function call.
- .SH OPTIONS
- .IP CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE
- See \fICURLMOPT_CHUNK_LENGTH_PENALTY_SIZE(3)\fP
- .IP CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE
- See \fICURLMOPT_CONTENT_LENGTH_PENALTY_SIZE(3)\fP
- .IP CURLMOPT_MAX_HOST_CONNECTIONS
- See \fICURLMOPT_MAX_HOST_CONNECTIONS(3)\fP
- .IP CURLMOPT_MAX_PIPELINE_LENGTH
- See \fICURLMOPT_MAX_PIPELINE_LENGTH(3)\fP
- .IP CURLMOPT_MAX_TOTAL_CONNECTIONS
- See \fICURLMOPT_MAX_TOTAL_CONNECTIONS(3)\fP
- .IP CURLMOPT_MAXCONNECTS
- See \fICURLMOPT_MAXCONNECTS(3)\fP
- .IP CURLMOPT_PIPELINING
- See \fICURLMOPT_PIPELINING(3)\fP
- .IP CURLMOPT_PIPELINING_SITE_BL
- See \fICURLMOPT_PIPELINING_SITE_BL(3)\fP
- .IP CURLMOPT_PIPELINING_SERVER_BL
- See \fICURLMOPT_PIPELINING_SERVER_BL(3)\fP
- .IP CURLMOPT_PUSHFUNCTION
- See \fICURLMOPT_PUSHFUNCTION(3)\fP
- .IP CURLMOPT_PUSHDATA
- See \fICURLMOPT_PUSHDATA(3)\fP
- .IP CURLMOPT_SOCKETFUNCTION
- See \fICURLMOPT_SOCKETFUNCTION(3)\fP
- .IP CURLMOPT_SOCKETDATA
- See \fICURLMOPT_SOCKETDATA(3)\fP
- .IP CURLMOPT_TIMERFUNCTION
- See \fICURLMOPT_TIMERFUNCTION(3)\fP
- .IP CURLMOPT_TIMERDATA
- See \fICURLMOPT_TIMERDATA(3)\fP
- .IP CURLMOPT_MAX_CONCURRENT_STREAMS
- See \fICURLMOPT_MAX_CONCURRENT_STREAMS(3)\fP
- .SH EXAMPLE
- .fi
- /* Limit the amount of simultaneous connections curl should allow: */
- curl_multi_setopt(handle, CURLMOPT_MAXCONNECTS, (long)MAX_PARALLEL);
- .nf
- .SH AVAILABILITY
- Added in 7.15.4
- .SH RETURN VALUE
- The standard CURLMcode for multi interface error codes. Note that it returns a
- CURLM_UNKNOWN_OPTION if you try setting an option that this version of libcurl
- does not know of.
- .SH "SEE ALSO"
- .BR curl_multi_cleanup "(3), " curl_multi_init "(3), "
- .BR curl_multi_socket "(3), " curl_multi_info_read "(3)"
|
