aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLINFO_LASTSOCKET.md
diff options
context:
space:
mode:
authorAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>2024-02-28 21:23:34 +0000
committerGerrit Code Review <noreply-gerritcodereview@google.com>2024-02-28 21:23:34 +0000
commit6a9977cde9914ddf75f6debd9810591e5b8f84ef (patch)
tree1b01132e15db02538dcf10922559df5a286d1cd6 /docs/libcurl/opts/CURLINFO_LASTSOCKET.md
parente73cfcb7f7f74bf28d5b22092f1fbe4b2e7bfccf (diff)
parent80c3417987dd57711bf1832cc267599b55d1836e (diff)
downloadcurl-simpleperf-release.tar.gz
Merge "Snap for 11510257 from 5a7a71055c2c5ea8e7342422964c47f1e2d03970 to simpleperf-release" into simpleperf-releasesimpleperf-release
Diffstat (limited to 'docs/libcurl/opts/CURLINFO_LASTSOCKET.md')
-rw-r--r--docs/libcurl/opts/CURLINFO_LASTSOCKET.md77
1 files changed, 77 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLINFO_LASTSOCKET.md b/docs/libcurl/opts/CURLINFO_LASTSOCKET.md
new file mode 100644
index 000000000..b1619ebdb
--- /dev/null
+++ b/docs/libcurl/opts/CURLINFO_LASTSOCKET.md
@@ -0,0 +1,77 @@
+---
+c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
+SPDX-License-Identifier: curl
+Title: CURLINFO_LASTSOCKET
+Section: 3
+Source: libcurl
+See-also:
+ - CURLINFO_ACTIVESOCKET (3)
+ - CURLOPT_CONNECT_ONLY (3)
+ - curl_easy_getinfo (3)
+ - curl_easy_setopt (3)
+---
+
+# NAME
+
+CURLINFO_LASTSOCKET - get the last socket used
+
+# SYNOPSIS
+
+~~~c
+#include <curl/curl.h>
+
+CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_LASTSOCKET, long *socket);
+~~~
+
+# DESCRIPTION
+
+Deprecated since 7.45.0. Use CURLINFO_ACTIVESOCKET(3) instead.
+
+Pass a pointer to a long to receive the last socket used by this curl
+session. If the socket is no longer valid, -1 is returned. When you finish
+working with the socket, you must call curl_easy_cleanup(3) as usual and
+let libcurl close the socket and cleanup other resources associated with the
+handle. This is typically used in combination with
+CURLOPT_CONNECT_ONLY(3).
+
+NOTE: this API is deprecated since it is not working on win64 where the SOCKET
+type is 64 bits large while its 'long' is 32 bits. Use the
+CURLINFO_ACTIVESOCKET(3) instead, if possible.
+
+# PROTOCOLS
+
+All
+
+# EXAMPLE
+
+~~~c
+int main(void)
+{
+ CURL *curl = curl_easy_init();
+ if(curl) {
+ CURLcode res;
+ long sockfd; /* does not work on win64! */
+ curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
+
+ /* Do not do the transfer - only connect to host */
+ curl_easy_setopt(curl, CURLOPT_CONNECT_ONLY, 1L);
+ res = curl_easy_perform(curl);
+
+ /* Extract the socket from the curl handle */
+ res = curl_easy_getinfo(curl, CURLINFO_LASTSOCKET, &sockfd);
+
+ if(res != CURLE_OK) {
+ printf("Error: %s\n", curl_easy_strerror(res));
+ return 1;
+ }
+ }
+}
+~~~
+
+# AVAILABILITY
+
+Added in 7.15.2
+
+# RETURN VALUE
+
+Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.