curl_easy_duphandle.3 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  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. .TH curl_easy_duphandle 3 "19 Sep 2014" "libcurl" "libcurl Manual"
  23. .SH NAME
  24. curl_easy_duphandle - Clone a libcurl session handle
  25. .SH SYNOPSIS
  26. .nf
  27. #include <curl/curl.h>
  28. CURL *curl_easy_duphandle(CURL *handle);
  29. .fi
  30. .SH DESCRIPTION
  31. This function will return a new curl handle, a duplicate, using all the
  32. options previously set in the input curl \fIhandle\fP. Both handles can
  33. subsequently be used independently and they must both be freed with
  34. \fIcurl_easy_cleanup(3)\fP.
  35. All strings that the input handle has been told to point to (as opposed to
  36. copy) with previous calls to \fIcurl_easy_setopt(3)\fP using char * inputs,
  37. will be pointed to by the new handle as well. You must therefore make sure to
  38. keep the data around until both handles have been cleaned up.
  39. The new handle will \fBnot\fP inherit any state information, no connections,
  40. no SSL sessions and no cookies. It also will not inherit any share object
  41. states or options (it will be made as if \fICURLOPT_SHARE(3)\fP was set to
  42. NULL).
  43. In multi-threaded programs, this function must be called in a synchronous way,
  44. the input handle may not be in use when cloned.
  45. .SH EXAMPLE
  46. .nf
  47. CURL *curl = curl_easy_init();
  48. CURL *nother;
  49. if(curl) {
  50. CURLcode res;
  51. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  52. nother = curl_easy_duphandle(curl);
  53. res = curl_easy_perform(nother);
  54. curl_easy_cleanup(nother);
  55. curl_easy_cleanup(curl);
  56. }
  57. .fi
  58. .SH AVAILABILITY
  59. Added in 7.9
  60. .SH RETURN VALUE
  61. If this function returns NULL, something went wrong and no valid handle was
  62. returned.
  63. .SH "SEE ALSO"
  64. .BR curl_easy_init "(3)," curl_easy_cleanup "(3)," curl_easy_reset "(3),"
  65. .BR curl_global_init "(3)"