curl_multi_setopt(3)

1curl_multi_setopt(3)            libcurl Manual            curl_multi_setopt(3)
2
3
4

NAME

6       curl_multi_setopt - set options for a curl multi handle
7

SYNOPSIS

9       #include <curl/curl.h>
10
11       CURLMcode curl_multi_setopt(CURLM *multi_handle, CURLMoption option, param);
12

DESCRIPTION

14       curl_multi_setopt(3)  is used to tell a libcurl multi handle how to be‐
15       have. By using the appropriate options to curl_multi_setopt(3), you can
16       change libcurl's behavior when using that multi handle. All options are
17       set with the option followed by the parameter param. That parameter can
18       be  a long, a function pointer, an object pointer or a curl_off_t type,
19       depending on what the specific option expects. Read this  manual  care‐
20       fully  as  bad  input values may cause libcurl to behave badly. You can
21       only set one option in each function call.
22
23

OPTIONS

25       CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE
26              See CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE(3)
27
28       CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE
29              See CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE(3)
30
31       CURLMOPT_MAX_HOST_CONNECTIONS
32              See CURLMOPT_MAX_HOST_CONNECTIONS(3)
33
34       CURLMOPT_MAX_PIPELINE_LENGTH
35              See CURLMOPT_MAX_PIPELINE_LENGTH(3)
36
37       CURLMOPT_MAX_TOTAL_CONNECTIONS
38              See CURLMOPT_MAX_TOTAL_CONNECTIONS(3)
39
40       CURLMOPT_MAXCONNECTS
41              See CURLMOPT_MAXCONNECTS(3)
42
43       CURLMOPT_PIPELINING
44              See CURLMOPT_PIPELINING(3)
45
46       CURLMOPT_PIPELINING_SITE_BL
47              See CURLMOPT_PIPELINING_SITE_BL(3)
48
49       CURLMOPT_PIPELINING_SERVER_BL
50              See CURLMOPT_PIPELINING_SERVER_BL(3)
51
52       CURLMOPT_PUSHFUNCTION
53              See CURLMOPT_PUSHFUNCTION(3)
54
55       CURLMOPT_PUSHDATA
56              See CURLMOPT_PUSHDATA(3)
57
58       CURLMOPT_SOCKETFUNCTION
59              See CURLMOPT_SOCKETFUNCTION(3)
60
61       CURLMOPT_SOCKETDATA
62              See CURLMOPT_SOCKETDATA(3)
63
64       CURLMOPT_TIMERFUNCTION
65              See CURLMOPT_TIMERFUNCTION(3)
66
67       CURLMOPT_TIMERDATA
68              See CURLMOPT_TIMERDATA(3)
69
70       CURLMOPT_MAX_CONCURRENT_STREAMS
71              See CURLMOPT_MAX_CONCURRENT_STREAMS(3)
72

EXAMPLE

74         /* Limit the amount of simultaneous connections curl should allow: */
75         curl_multi_setopt(handle, CURLMOPT_MAXCONNECTS, (long)MAX_PARALLEL);
76

AVAILABILITY

78       Added in 7.15.4
79

RETURN VALUE

81       The standard CURLMcode for multi interface error codes.  Note  that  it
82       returns  a  CURLM_UNKNOWN_OPTION if you try setting an option that this
83       version of libcurl does not know of.
84