CURLINFO_LASTSOCKET.3 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2017, 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.haxx.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 CURLINFO_LASTSOCKET 3 "May 06, 2017" "libcurl 7.61.1" "curl_easy_getinfo options"
  24. .SH NAME
  25. CURLINFO_LASTSOCKET \- get the last socket used
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_LASTSOCKET, long *socket);
  29. .SH DESCRIPTION
  30. Deprecated since 7.45.0. Use \fICURLINFO_ACTIVESOCKET(3)\fP instead.
  31. Pass a pointer to a long to receive the last socket used by this curl
  32. session. If the socket is no longer valid, -1 is returned. When you finish
  33. working with the socket, you must call curl_easy_cleanup() as usual and let
  34. libcurl close the socket and cleanup other resources associated with the
  35. handle. This is typically used in combination with
  36. \fICURLOPT_CONNECT_ONLY(3)\fP.
  37. NOTE: this API is deprecated since it is not working on win64 where the SOCKET
  38. type is 64 bits large while its 'long' is 32 bits. Use the
  39. \fICURLINFO_ACTIVESOCKET(3)\fP instead, if possible.
  40. .SH PROTOCOLS
  41. All
  42. .SH EXAMPLE
  43. .nf
  44. CURL *curl = curl_easy_init();
  45. if(curl) {
  46. long sockfd; /* doesn't work on win64! */
  47. curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  48. /* Do not do the transfer - only connect to host */
  49. curl_easy_setopt(curl, CURLOPT_CONNECT_ONLY, 1L);
  50. res = curl_easy_perform(curl);
  51. /* Extract the socket from the curl handle */
  52. res = curl_easy_getinfo(curl, CURLINFO_LASTSOCKET, &sockfd);
  53. if(res != CURLE_OK) {
  54. printf("Error: %s\\n", curl_easy_strerror(res));
  55. return 1;
  56. }
  57. }
  58. .fi
  59. .SH AVAILABILITY
  60. Added in 7.15.2
  61. .SH RETURN VALUE
  62. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  63. .SH "SEE ALSO"
  64. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  65. .BR CURLINFO_ACTIVESOCKET "(3), "