curl / libcurl / API / curl_easy_setopt / CURLOPT_CLOSESOCKETDATA

CURLOPT_CLOSESOCKETDATA explained

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 remains untouched by libcurl and passed as the first argument in the closesocket callback set with CURLOPT_CLOSESOCKETFUNCTION.

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.