e694c8284a
Expand a little. - mention the type name of the return code - avoid stating which exact return codes that might be returned, as that varies over time, builds and conditions - avoid stating some always return OK - refer to the manpage documenting all the return codes Closes #15900
85 lines
2.1 KiB
Markdown
85 lines
2.1 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLINFO_ACTIVESOCKET
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLINFO_LASTSOCKET (3)
|
|
- CURLOPT_CONNECT_ONLY (3)
|
|
- curl_easy_getinfo (3)
|
|
- curl_easy_setopt (3)
|
|
Protocol:
|
|
- All
|
|
Added-in: 7.45.0
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLINFO_ACTIVESOCKET - get the active socket
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_ACTIVESOCKET,
|
|
curl_socket_t *socket);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass a pointer to a curl_socket_t to receive the most recently active socket
|
|
used for the transfer connection by this curl session. If the socket is no
|
|
longer valid, *CURL_SOCKET_BAD* is returned. When you are finished working
|
|
with the socket, you must call curl_easy_cleanup(3) as usual on the easy
|
|
handle and let libcurl close the socket and cleanup other resources associated
|
|
with the handle. This option returns the active socket only after the transfer
|
|
is complete, and is typically used in combination with
|
|
CURLOPT_CONNECT_ONLY(3), which skips the transfer phase.
|
|
|
|
CURLINFO_ACTIVESOCKET(3) was added as a replacement for
|
|
CURLINFO_LASTSOCKET(3) since that one is not working on all platforms.
|
|
|
|
# %PROTOCOLS%
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode res;
|
|
curl_socket_t sockfd;
|
|
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);
|
|
if(res != CURLE_OK) {
|
|
printf("Error: %s\n", curl_easy_strerror(res));
|
|
curl_easy_cleanup(curl);
|
|
return 1;
|
|
}
|
|
|
|
/* Extract the socket from the curl handle */
|
|
res = curl_easy_getinfo(curl, CURLINFO_ACTIVESOCKET, &sockfd);
|
|
if(!res && sockfd != CURL_SOCKET_BAD) {
|
|
/* operate on sockfd */
|
|
}
|
|
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# %AVAILABILITY%
|
|
|
|
# RETURN VALUE
|
|
|
|
curl_easy_getinfo(3) returns a CURLcode indicating success or error.
|
|
|
|
CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
|
|
libcurl-errors(3).
|