mirror of
https://codeberg.org/kiss-community/repo
synced 2024-12-24 16:30:04 -07:00
55 lines
1.3 KiB
Groff
55 lines
1.3 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_CLOSESOCKETDATA.md
|
|
.TH CURLOPT_CLOSESOCKETDATA 3 "2024-07-29" libcurl
|
|
.SH NAME
|
|
CURLOPT_CLOSESOCKETDATA \- pointer passed to the socket close callback
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CLOSESOCKETDATA,
|
|
void *pointer);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a \fIpointer\fP that remains untouched by libcurl and passed as the first
|
|
argument in the closesocket callback set with
|
|
\fICURLOPT_CLOSESOCKETFUNCTION(3)\fP.
|
|
.SH DEFAULT
|
|
NULL
|
|
.SH PROTOCOLS
|
|
This functionality affects all supported protocols
|
|
.SH EXAMPLE
|
|
.nf
|
|
struct priv {
|
|
void *custom;
|
|
};
|
|
|
|
static int closesocket(void *clientp, curl_socket_t item)
|
|
{
|
|
struct priv *my = clientp;
|
|
printf("our ptr: %p\\n", my->custom);
|
|
|
|
printf("libcurl wants to close %d now\\n", (int)item);
|
|
return 0;
|
|
}
|
|
|
|
int main(void)
|
|
{
|
|
struct priv myown;
|
|
CURL *curl = curl_easy_init();
|
|
|
|
/* call this function to close sockets */
|
|
curl_easy_setopt(curl, CURLOPT_CLOSESOCKETFUNCTION, closesocket);
|
|
curl_easy_setopt(curl, CURLOPT_CLOSESOCKETDATA, &myown);
|
|
|
|
curl_easy_perform(curl);
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in curl 7.21.7
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_CLOSESOCKETFUNCTION (3),
|
|
.BR CURLOPT_OPENSOCKETFUNCTION (3)
|