curl / libcurl / API / curl_easy_setopt / CURLOPT_CLOSESOCKETFUNCTION

CURLOPT_CLOSESOCKETFUNCTION explained

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 prototype 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_OPENSOCKETFUNCTION option. Return 0 to signal success and 1 if there was an error.

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

DEFAULT

By default libcurl uses the standard socket close function.

PROTOCOLS

All

EXAMPLE

TODO

AVAILABILITY

Added in 7.21.7

RETURN VALUE

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

SEE ALSO

CURLOPT_CLOSESOCKETDATA, CURLOPT_OPENSOCKETFUNCTION

This HTML page was made with roffit.