Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLINFO_ACTIVESOCKET (3)

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

CURLINFO_ACTIVESOCKET(3)   curl_easy_getinfo options  CURLINFO_ACTIVESOCKET(3)



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 active socket used by
       this curl session. If the socket is no longer valid, CURL_SOCKET_BAD is
       returned.  When  you  finish  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
       is typically used in combination with CURLOPT_CONNECT_ONLY(3).

       This option was added as a replacement for CURLINFO_LASTSOCKET(3) since
       that one isn't working on all platforms.

PROTOCOLS
       All

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_socket_t sockfd;
         curl_easy_setopt(curl, CURLOPT_URL, "http://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_ACTIVESOCKET, &sockfd);

         if(res != CURLE_OK) {
           printf("Error: %s\n", curl_easy_strerror(res));
           return 1;
         }
       }

AVAILABILITY
       Added in 7.45.0

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


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       curl_easy_getinfo(3), curl_easy_setopt(3), CURLINFO_LASTSOCKET(3),



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.44.0                    12 Sep 2015         CURLINFO_ACTIVESOCKET(3)