curl-share-setopt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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>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>
   Sets an option on the given cURL share handle.
  </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">
               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 within 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="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> 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
-->