CURLOPT_CLOSESOCKETDATA.3 2.2 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_CLOSESOCKETDATA 3 "16 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_CLOSESOCKETDATA \- pointer passed to the socket close callback
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CLOSESOCKETDATA,
  30. void *pointer);
  31. .fi
  32. .SH DESCRIPTION
  33. Pass a \fIpointer\fP that will be untouched by libcurl and passed as the first
  34. argument in the closesocket callback set with
  35. \fICURLOPT_CLOSESOCKETFUNCTION(3)\fP.
  36. .SH DEFAULT
  37. The default value of this parameter is NULL.
  38. .SH PROTOCOLS
  39. All except file:
  40. .SH EXAMPLE
  41. .nf
  42. static int closesocket(void *clientp, curl_socket_t item)
  43. {
  44. printf("libcurl wants to close %d now\\n", (int)item);
  45. return 0;
  46. }
  47. /* call this function to close sockets */
  48. curl_easy_setopt(curl, CURLOPT_CLOSESOCKETFUNCTION, closesocket);
  49. curl_easy_setopt(curl, CURLOPT_CLOSESOCKETDATA, &sockfd);
  50. .fi
  51. .SH AVAILABILITY
  52. Added in 7.21.7
  53. .SH RETURN VALUE
  54. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  55. .SH "SEE ALSO"
  56. .BR CURLOPT_CLOSESOCKETFUNCTION "(3), " CURLOPT_OPENSOCKETFUNCTION "(3), "