CURLINFO_LASTSOCKET.3 2.7 KB

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