1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 330511 $ -->
<refentry xml:id="function.curl-share-setopt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>curl_share_setopt</refname>
<refpurpose>Set an option for a cURL share handle.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>curl_share_setopt</methodname>
<methodparam><type>resource</type><parameter>sh</parameter></methodparam>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Sets an option on the given cURL share handle.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>sh</parameter></term>
<listitem>
<para>
A cURL share handle returned by <function>curl_share_init</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
<informaltable>
<tgroup cols="3">
<thead>
<row>
<entry valign="top">Option</entry>
<entry valign="top">Description</entry>
</row>
</thead>
<tbody>
<row>
<entry valign="top"><constant>CURLSHOPT_SHARE</constant></entry>
<entry valign="top">
Specifies a type of data that should be shared.
</entry>
</row>
<row>
<entry valign="top"><constant>CURLSHOPT_UNSHARE</constant></entry>
<entry valign="top">
Specifies a type of data that will be no longer shared.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
<informaltable>
<tgroup cols="3">
<thead>
<row>
<entry valign="top">Value</entry>
<entry valign="top">Description</entry>
</row>
</thead>
<tbody>
<row>
<entry valign="top"><constant>CURL_LOCK_DATA_COOKIE</constant></entry>
<entry valign="top">
Shares cookie data.
</entry>
</row>
<row>
<entry valign="top"><constant>CURL_LOCK_DATA_DNS</constant></entry>
<entry valign="top">
Shares DNS cache. Note that when you use cURL multi handles,
all handles added to the same multi handle will share DNS cache
by default.
</entry>
</row>
<row>
<entry valign="top"><constant>CURL_LOCK_DATA_SSL_SESSION</constant></entry>
<entry valign="top">
Shares SSL session IDs, reducing the time spent on the SSL
handshake when reconnecting to the same server. Note that SSL
session IDs are reused withing the same handle by default.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>curl_share_setopt</function> example</title>
<para>
This example will create a cURL share handle, add two cURL handles to it,
and then run them with cookie data sharing.
</para>
<programlisting role="php">
<![CDATA[
<?php
// Create cURL share handle and set it to share cookie data
$sh = curl_share_init();
curl_share_setopt($sh, CURLSHOPT_SHARE, CURL_LOCK_DATA_COOKIE);
// Initialize the first cURL handle and assign the share handle to it
$ch1 = curl_init("http://example.com/");
curl_setopt($ch1, CURLOPT_SHARE, $sh);
// Execute the first cURL handle
curl_exec($ch1);
// Initialize the second cURL handle and assign the share handle to it
$ch2 = curl_init("http://php.net/");
curl_setopt($ch2, CURLOPT_SHARE, $sh);
// Execute the second cURL handle
// all cookies from $ch1 handle are shared with $ch2 handle
curl_exec($ch2);
// Close the cURL share handle
curl_share_close($sh);
// Close the cURL handles
curl_close($ch1);
curl_close($ch2);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
