Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_CLOSESOCKETFUNCTION (3)

Name

CURLOPT_CLOSESOCKETFUNCTION - callback to socket close replacement function

Synopsis

#include <curl/curl.h>

int closesocket_callback(void *clientp, curl_socket_t item);

CURLcode  curl_easy_setopt(CURL  *handle,  CURLOPT_CLOSESOCKETFUNCTION,
closesocket_callback);

Description

curl_easy_setopt options                        CURLOPT_CLOSESOCKETFUNCTION(3)



NAME
       CURLOPT_CLOSESOCKETFUNCTION  -  callback  to  socket  close replacement
       function

SYNOPSIS
       #include <curl/curl.h>

       int closesocket_callback(void *clientp, curl_socket_t item);

       CURLcode  curl_easy_setopt(CURL  *handle,  CURLOPT_CLOSESOCKETFUNCTION,
       closesocket_callback);

DESCRIPTION
       Pass a pointer to your callback function, which should match the proto-
       type shown above.

       This callback function gets called by libcurl instead of  the  close(3)
       or  closesocket(3) call when sockets are closed (not for any other file
       descriptors). This is pretty much the reverse to the  CURLOPT_OPENSOCK-
       ETFUNCTION(3)  option. Return 0 to signal success and 1 if there was an
       error.

       The clientp pointer is set with CURLOPT_CLOSESOCKETDATA(3). item is the
       socket libcurl wants to be closed.

DEFAULT
       By default libcurl uses the standard socket close function.

PROTOCOLS
       All

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_CLOSESOCKETDATA(3), CURLOPT_OPENSOCKETFUNCTION(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.37.0                    16 Jun 2014
                                                CURLOPT_CLOSESOCKETFUNCTION(3)