Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_CLOSESOCKETDATA (3)

Name

CURLOPT_CLOSESOCKETDATA - pointer passed to the socket close callback

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CLOSESOCKETDATA,
void *pointer);

Description

curl_easy_setopt options                            CURLOPT_CLOSESOCKETDATA(3)



NAME
       CURLOPT_CLOSESOCKETDATA - pointer passed to the socket close callback

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CLOSESOCKETDATA,
                                 void *pointer);

DESCRIPTION
       Pass  a  pointer  that  will  be untouched by libcurl and passed as the
       first argument in the closesocket callback set with  CURLOPT_CLOSESOCK-
       ETFUNCTION(3).

DEFAULT
       The default value of this parameter is NULL.

PROTOCOLS
       All except file:

EXAMPLE
       static int closesocket(void *clientp, curl_socket_t item)
       {
         printf("libcurl wants to close %d now\n", (int)item);
         return 0;
       }

       /* call this function to close sockets */
       curl_easy_setopt(curl, CURLOPT_CLOSESOCKETFUNCTION, closesocket);
       curl_easy_setopt(curl, CURLOPT_CLOSESOCKETDATA, &sockfd);

AVAILABILITY
       Added in 7.21.7

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
       CURLOPT_CLOSESOCKETFUNCTION(3), CURLOPT_OPENSOCKETFUNCTION(3),



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

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



libcurl 7.83.1                 November 26, 2021
                                                    CURLOPT_CLOSESOCKETDATA(3)