CURLOPT_SHARE.3 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
  9. .\" *
  10. .\" * This software is licensed as described in the file COPYING, which
  11. .\" * you should have received as part of this distribution. The terms
  12. .\" * are also available at https://curl.se/docs/copyright.html.
  13. .\" *
  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15. .\" * copies of the Software, and permit persons to whom the Software is
  16. .\" * furnished to do so, under the terms of the COPYING file.
  17. .\" *
  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19. .\" * KIND, either express or implied.
  20. .\" *
  21. .\" **************************************************************************
  22. .\"
  23. .TH CURLOPT_SHARE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_SHARE \- share handle to use
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SHARE, CURLSH *share);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a \fIshare\fP handle as a parameter. The share handle must have been
  33. created by a previous call to \fIcurl_share_init(3)\fP. Setting this option,
  34. will make this curl handle use the data from the shared handle instead of
  35. keeping the data to itself. This enables several curl handles to share
  36. data. If the curl handles are used simultaneously in multiple threads, you
  37. \fBMUST\fP use the locking methods in the share handle. See
  38. \fIcurl_share_setopt(3)\fP for details.
  39. If you add a share that is set to share cookies, your easy handle will use
  40. that cookie cache and get the cookie engine enabled. If you unshare an object
  41. that was using cookies (or change to another object that does not share
  42. cookies), the easy handle will get its cookie engine disabled.
  43. Data that the share object is not set to share will be dealt with the usual
  44. way, as if no share was used.
  45. Set this option to NULL again to stop using that share object.
  46. .SH DEFAULT
  47. NULL
  48. .SH PROTOCOLS
  49. All
  50. .SH EXAMPLE
  51. .nf
  52. CURL *curl = curl_easy_init();
  53. CURL *curl2 = curl_easy_init(); /* a second handle */
  54. if(curl) {
  55. CURLSH *shobject = curl_share_init();
  56. curl_share_setopt(shobject, CURLSHOPT_SHARE, CURL_LOCK_DATA_COOKIE);
  57. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  58. curl_easy_setopt(curl, CURLOPT_COOKIEFILE, "");
  59. curl_easy_setopt(curl, CURLOPT_SHARE, shobject);
  60. ret = curl_easy_perform(curl);
  61. curl_easy_cleanup(curl);
  62. /* the second handle shares cookies from the first */
  63. curl_easy_setopt(curl2, CURLOPT_URL, "https://example.com/second");
  64. curl_easy_setopt(curl2, CURLOPT_COOKIEFILE, "");
  65. curl_easy_setopt(curl2, CURLOPT_SHARE, shobject);
  66. ret = curl_easy_perform(curl2);
  67. curl_easy_cleanup(curl2);
  68. curl_share_cleanup(shobject);
  69. }
  70. .fi
  71. .SH AVAILABILITY
  72. Always
  73. .SH RETURN VALUE
  74. Returns CURLE_OK
  75. .SH "SEE ALSO"
  76. .BR CURLOPT_COOKIE "(3), "