curl-share-setopt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b7f8c11e56ff1c57a2993e2ed7e5c5ace18637fd Maintainer:duanxiaoqiang Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<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>为 cURL 共享句柄设置选项</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>curl_share_setopt</methodname>
   <methodparam><type>CurlShareHandle</type><parameter>share_handle</parameter></methodparam>
   <methodparam><type>int</type><parameter>option</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   为指定的 cURL 共享句柄设置选项。
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   &curl.sh.description;
   <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">
               指定要共享的数据类型。
           </entry>
          </row>
          <row>
           <entry valign="top"><constant>CURLSHOPT_UNSHARE</constant></entry>
           <entry valign="top">
               指定不再共享的数据类型。
           </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">
               共享 cookie 数据。
           </entry>
          </row>
          <row>
           <entry valign="top"><constant>CURL_LOCK_DATA_DNS</constant></entry>
           <entry valign="top">
               共享 DNS 缓存。注意，当你使用 cURL 多句柄时，默认所有添加在同一个多句柄的句柄都将会共享 DNS 缓存。 
           </entry>
          </row>
          <row>
           <entry valign="top"><constant>CURL_LOCK_DATA_SSL_SESSION</constant></entry>
           <entry valign="top">
               共享 SSL 的 session ID, 在重连同样的服务器时减少 SSL 握手时间。注意，SSL 的 session ID 在同一个的句柄中默认是重复使用的。
           </entry>
          </row>
         </tbody>
        </tgroup>
       </informaltable>
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &curl.changelog.share-handle-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>curl_share_setopt</function> 示例</title>
    <para>
     以下示例将会创建 cURL 共享句柄，并且往其中添加两个 cURL 句柄，最后共享这两个 cURL 句柄的 cookie 数据运行。
    </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
-->