curl / libcurl / API / curl_easy_getinfo / CURLINFO_ACTIVESOCKET

CURLINFO_ACTIVESOCKET explained

Name

CURLINFO_ACTIVESOCKET - get the active socket

Synopsis

#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 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, which skips the transfer phase.

CURLINFO_ACTIVESOCKET was added as a replacement for CURLINFO_LASTSOCKET since that one is not working on all platforms.

Protocols

This functionality affects all supported protocols

Example

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

Added in curl 7.45.0

Return value

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.