CURLOPT_SSL_SESSIONID_CACHE.3 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  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_SSL_SESSIONID_CACHE 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_SSL_SESSIONID_CACHE \- use the SSL session-ID cache
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_SESSIONID_CACHE,
  30. long enabled);
  31. .SH DESCRIPTION
  32. Pass a long set to 0 to disable libcurl's use of SSL session-ID caching. Set
  33. this to 1 to enable it. By default all transfers are done using the cache
  34. enabled. While nothing ever should get hurt by attempting to reuse SSL
  35. session-IDs, there seem to be or have been broken SSL implementations in the
  36. wild that may require you to disable this in order for you to succeed.
  37. .SH DEFAULT
  38. 1
  39. .SH PROTOCOLS
  40. All TLS-based
  41. .SH EXAMPLE
  42. .nf
  43. CURL *curl = curl_easy_init();
  44. if(curl) {
  45. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  46. /* switch off session-id use! */
  47. curl_easy_setopt(curl, CURLOPT_SSL_SESSIONID_CACHE, 0L);
  48. ret = curl_easy_perform(curl);
  49. curl_easy_cleanup(curl);
  50. }
  51. .fi
  52. .SH AVAILABILITY
  53. Added in 7.16.0
  54. .SH RETURN VALUE
  55. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  56. .SH "SEE ALSO"
  57. .BR CURLOPT_DNS_CACHE_TIMEOUT "(3), " CURLOPT_SSLVERSION "(3), "