curl_share_setopt(3) [php man page]

CURL_SHARE_SETOPT(3)							 1						      CURL_SHARE_SETOPT(3)

curl_share_setopt - Set an option for a cURL share handle.

SYNOPSIS

       bool curl_share_setopt (resource  $sh, int  $option, string  $value)

DESCRIPTION

	Sets an option on the given cURL share handle.

PARAMETERS

	      o $sh
		- A cURL share handle returned by curl_share_init(3).

	      o $option
		-

	      +------------------+--------------------------------------+---+
	      |     Option	 |					|   |
	      | 		 |					|   |
	      | 		 |	       Description		|   |
	      | 		 |					|   |
	      +------------------+--------------------------------------+---+
	      | 		 |					|   |
	      | CURLSHOPT_SHARE  |					|   |
	      | 		 |					|   |
	      | 		 |  Specifies	a  type  of  data  that |   |
	      | 		 | should be shared.			|   |
	      | 		 |					|   |
	      | 		 |					|   |
	      |CURLSHOPT_UNSHARE |					|   |
	      | 		 |					|   |
	      | 		 |  Specifies a type of data that  will |   |
	      | 		 | be no longer shared. 		|   |
	      | 		 |					|   |
	      +------------------+--------------------------------------+---+
	      o $value
		-

	      +---------------------------+--------------------------------------+---+
	      | 	 Value		  |					 |   |
	      | 			  |					 |   |
	      | 			  |		Description		 |   |
	      | 			  |					 |   |
	      +---------------------------+--------------------------------------+---+
	      | 			  |					 |   |
	      |  CURL_LOCK_DATA_COOKIE	  |					 |   |
	      | 			  |					 |   |
	      | 			  |	     Shares cookie data.	 |   |
	      | 			  |					 |   |
	      | 			  |					 |   |
	      |    CURL_LOCK_DATA_DNS	  |					 |   |
	      | 			  |					 |   |
	      | 			  |  Shares  DNS  cache.  Note that when |   |
	      | 			  | you use cURL multi handles, all han- |   |
	      | 			  | dles  added to the same multi handle |   |
	      | 			  | will share DNS cache by default.	 |   |
	      | 			  |					 |   |
	      | 			  |					 |   |
	      |CURL_LOCK_DATA_SSL_SESSION |					 |   |
	      | 			  |					 |   |
	      | 			  |  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.				 |   |
	      | 			  |					 |   |
	      +---------------------------+--------------------------------------+---+
RETURN VALUES

	Returns TRUE on success or FALSE on failure.

EXAMPLES

       Example #1

	      curl_share_setopt(3) example

	       This example will create a cURL share handle, add two cURL handles to it, and then run them with cookie data sharing.

	      <?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);
	      ?>

PHP Documentation Group 												      CURL_SHARE_SETOPT(3)

Check Out this Related Man Page

libcurl-share(3)					      libcurl share interface						  libcurl-share(3)

NAME

       libcurl-share - how to use the share interface

DESCRIPTION

       This  is an overview on how to use the libcurl share interface in your C programs. There are specific man pages for each function mentioned
       in here.

       All functions in the share interface are prefixed with curl_share.

OBJECTIVES

       The share interface was added to enable sharing of data between curl "handles".

ONE SET OF DATA - MANY TRANSFERS
       You can have multiple easy handles share data between them. Have them update and use the same cookie database or DNS cache! This way,  each
       single transfer will take advantage from data updates made by the other transfer(s).

SHARE OBJECT

       You create a shared object with curl_share_init(3). It returns a handle for a newly created one.

       You  tell  the  shared  object what data you want it to share by using curl_share_setopt(3). Currently you can only share DNS and/or COOKIE
       data.

       Since you can use this share from multiple threads, and libcurl has no internal thread synchronization, you must provide mutex callbacks if
       you're using this multi-threaded. You set lock and unlock functions with curl_share_setopt(3) too.

       Then,  you  make an easy handle to use this share, you set the CURLOPT_SHARE option with curl_easy_setopt(3), and pass in share handle. You
       can make any number of easy handles share the same share handle.

       To make an easy handle stop using that particular share, you set CURLOPT_SHARE to NULL for that easy handle. To make a handle stop  sharing
       a particular data, you can CURLSHOPT_UNSHARE it.

       When you're done using the share, make sure that no easy handle is still using it, and call curl_share_cleanup(3) on the handle.

SEE ALSO

       curl_share_init(3), curl_share_setopt(3), curl_share_cleanup(3)

libcurl 7.10.7							    8 Aug 2003							  libcurl-share(3)

Linux and UNIX Man Pages

curl_share_setopt(3) [php man page]

Check Out this Related Man Page