CURLINFO_CONN_ID.3 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  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_CONN_ID 3 "07 June 2023" "libcurl" "libcurl"
  26. .SH NAME
  27. CURLINFO_CONN_ID \- get the ID of the last connection used by the handle
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONN_ID,
  32. curl_off_t *conn_id);
  33. .fi
  34. .SH DESCRIPTION
  35. Pass a pointer to a \fIcurl_off_t\fP to receive the connection identifier last
  36. used by the handle. Stores -1 if there was no connection used.
  37. The connection id is unique among all connections using the same
  38. connection cache. This is implicitly the case for all connections in the
  39. same multi handle.
  40. .SH PROTOCOLS
  41. All
  42. .SH EXAMPLE
  43. .nf
  44. CURL *curl = curl_easy_init();
  45. if(curl) {
  46. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  47. /* Perform the request */
  48. res = curl_easy_perform(curl);
  49. if(!res) {
  50. curl_off_t conn_id;
  51. res = curl_easy_getinfo(curl, CURLINFO_CONN_ID, &conn_id);
  52. if(!res) {
  53. printf("Connection used: %" CURL_FORMAT_CURL_OFF_T "\\n", conn_id);
  54. }
  55. }
  56. }
  57. .fi
  58. .SH AVAILABILITY
  59. Added in 8.2.0
  60. .SH RETURN VALUE
  61. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  62. .SH "SEE ALSO"
  63. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  64. .BR CURLINFO_XFER_ID "(3), "