reference/curl/functions/curl-multi-setopt.xml
56171c30f4f4bb558537d9f5b400f21fdd2ebee8
...
...
@@ -1,44 +1,34 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-

4
3
<refentry xml:id="function.curl-multi-setopt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>curl_multi_setopt</refname>
7
-
<refpurpose>Set an option for the cURL multi handle</refpurpose>
6
+
<refpurpose>Set a cURL multi option</refpurpose>
8
7
</refnamediv>
9
8

10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
11
<methodsynopsis>
13
12
<type>bool</type><methodname>curl_multi_setopt</methodname>
14
-
<methodparam><type>resource</type><parameter>mh</parameter></methodparam>
13
+
<methodparam><type>CurlMultiHandle</type><parameter>multi_handle</parameter></methodparam>
15
14
<methodparam><type>int</type><parameter>option</parameter></methodparam>
16
15
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
17
16
</methodsynopsis>
18
17
<para>
19
-

18
+
Sets an option on the given cURL multi handle.
20
19
</para>
21
20

22
-
&warn.undocumented.func;
23
-

24
21
</refsect1>
25
22

26
23
<refsect1 role="parameters">
27
24
&reftitle.parameters;
28
25
<variablelist>
29
-
<varlistentry>
30
-
<term><parameter>mh</parameter></term>
31
-
<listitem>
32
-
<para>
33
-
34
-
</para>
35
-
</listitem>
36
-
</varlistentry>
26
+
&curl.mh.description;
37
27
<varlistentry>
38
28
<term><parameter>option</parameter></term>
39
29
<listitem>
40
30
<para>
41
-
One of the <constant>CURLMOPT_*</constant> constants.
31
+
One of the <constant>CURLMOPT_<replaceable>*</replaceable></constant> constants.
42
32
</para>
43
33
</listitem>
44
34
</varlistentry>
...
...
@@ -47,82 +37,9 @@
47
37
<listitem>
48
38
<para>
49
39
The value to be set on <parameter>option</parameter>.
50
-
</para>
51
-
<para>
52
-
<parameter>value</parameter> should be an <type>int</type> for the
53
-
following values of the <parameter>option</parameter> parameter:
54
-
<informaltable>
55
-
<tgroup cols="3">
56
-
<thead>
57
-
<row>
58
-
<entry valign="top">Option</entry>
59
-
<entry valign="top">Set <parameter>value</parameter> to</entry>
60
-
</row>
61
-
</thead>
62
-
<tbody>
63
-
<row>
64
-
<entry valign="top"><constant>CURLMOPT_PIPELINING</constant></entry>
65
-
<entry valign="top">
66
-
Pass 1 to enable or 0 to disable. Enabling pipelining on a multi
67
-
handle will make it attempt to perform HTTP Pipelining as far as
68
-
possible for transfers using this handle. This means that if you add
69
-
a second request that can use an already existing connection, the
70
-
second request will be "piped" on the same connection.
71
-
As of cURL 7.43.0 you can also pass 2 to try to multiplex the new
72
-
transfer over an existing HTTP/2 connection if possible.
73
-
Instead of integer literals, you can also use the CURLPIPE_*
74
-
constants if available.
75
-
</entry>
76
-
</row>
77
-
<row>
78
-
<entry valign="top"><constant>CURLMOPT_MAXCONNECTS</constant></entry>
79
-
<entry valign="top">
80
-
Pass a number that will be used as the maximum amount of
81
-
simultaneously open connections that libcurl may cache.
82
-
By default the size will be enlarged to fit four times the number
83
-
of handles added via <function>curl_multi_add_handle</function>.
84
-
When the cache is full, curl closes the oldest one in the cache
85
-
to prevent the number of open connections from increasing.
86
-
</entry>
87
-
</row>
88
-
<row>
89
-
<entry valign="top"><constant>CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE</constant></entry>
90
-
<entry valign="top">
91
-
Pass a number that specifies the chunk length threshold for pipelining
92
-
in bytes.
93
-
</entry>
94
-
</row>
95
-
<row>
96
-
<entry valign="top"><constant>CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE</constant></entry>
97
-
<entry valign="top">
98
-
Pass a number that specifies the size threshold for pipelining
99
-
penalty in bytes.
100
-
</entry>
101
-
</row>
102
-
<row>
103
-
<entry valign="top"><constant>CURLMOPT_MAX_HOST_CONNECTIONS</constant></entry>
104
-
<entry valign="top">
105
-
Pass a number that specifies the maximum number of connections to a
106
-
single host.
107
-
</entry>
108
-
</row>
109
-
<row>
110
-
<entry valign="top"><constant>CURLMOPT_MAX_PIPELINE_LENGTH</constant></entry>
111
-
<entry valign="top">
112
-
Pass a number that specifies the maximum number of requests in a
113
-
pipeline.
114
-
</entry>
115
-
</row>
116
-
<row>
117
-
<entry valign="top"><constant>CURLMOPT_MAX_TOTAL_CONNECTIONS</constant></entry>
118
-
<entry valign="top">
119
-
Pass a number that specifies the maximum number of simultaneously
120
-
open connections.
121
-
</entry>
122
-
</row>
123
-
</tbody>
124
-
</tgroup>
125
-
</informaltable>
40
+
See the description of the
41
+
<constant>CURLMOPT_<replaceable>*</replaceable></constant> constants
42
+
for details on the type of values each constant expects.
126
43
</para>
127
44
</listitem>
128
45
</varlistentry>
...
...
@@ -148,6 +65,19 @@
148
65
</row>
149
66
</thead>
150
67
<tbody>
68
+
<row>
69
+
<entry>8.2.0</entry>
70
+
<entry>
71
+
Introduced <constant>CURLMOPT_MAX_CONCURRENT_STREAMS</constant>.
72
+
</entry>
73
+
</row>
74
+
&curl.changelog.multi-handle-param;
75
+
<row>
76
+
<entry>7.1.0</entry>
77
+
<entry>
78
+
Introduced <constant>CURLMOPT_PUSHFUNCTION</constant>.
79
+
</entry>
80
+
</row>
151
81
<row>
152
82
<entry>7.0.7</entry>
153
83
<entry>
...
...
@@ -165,7 +95,6 @@
165
95
</refsect1>
166
96

167
97
</refentry>
168
-

169
98
<!-- Keep this comment at the end of the file
170
99
Local variables:
171
100
mode: sgml
172
101



Translation status