blob: 01c45913faf2418b98d0655153221afdc01d4b3c [file] [log] [blame]
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -07001.\" **************************************************************************
2.\" * _ _ ____ _
3.\" * Project ___| | | | _ \| |
4.\" * / __| | | | |_) | |
5.\" * | (__| |_| | _ <| |___
6.\" * \___|\___/|_| \_\_____|
7.\" *
Elliott Hughes82be86d2017-09-20 17:00:17 -07008.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -07009.\" *
10.\" * This software is licensed as described in the file COPYING, which
11.\" * you should have received as part of this distribution. The terms
Alex Deymo8f1a2142016-06-28 14:49:26 -070012.\" * are also available at https://curl.haxx.se/docs/copyright.html.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070013.\" *
14.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15.\" * copies of the Software, and permit persons to whom the Software is
16.\" * furnished to do so, under the terms of the COPYING file.
17.\" *
18.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19.\" * KIND, either express or implied.
20.\" *
21.\" **************************************************************************
22.\"
Elliott Hughes1ef06ba2018-05-30 15:43:58 -070023.TH CURLOPT_CLOSESOCKETDATA 3 "May 31, 2017" "libcurl 7.60.0" "curl_easy_setopt options"
Elliott Hughes82be86d2017-09-20 17:00:17 -070024
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070025.SH NAME
26CURLOPT_CLOSESOCKETDATA \- pointer passed to the socket close callback
27.SH SYNOPSIS
28#include <curl/curl.h>
29
30CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CLOSESOCKETDATA, void *pointer);
31.SH DESCRIPTION
32Pass a \fIpointer\fP that will be untouched by libcurl and passed as the first
33argument in the closesocket callback set with
34\fICURLOPT_CLOSESOCKETFUNCTION(3)\fP.
35.SH DEFAULT
36The default value of this parameter is NULL.
37.SH PROTOCOLS
38All except file:
39.SH EXAMPLE
Elliott Hughes82be86d2017-09-20 17:00:17 -070040.nf
41static int closesocket(void *clientp, curl_socket_t item)
42{
43 printf("libcurl wants to close %d now\n", (int)item);
44 return 0;
45}
46
47/* call this function to close sockets */
48curl_easy_setopt(curl, CURLOPT_CLOSESOCKETFUNCTION, closesocket);
49curl_easy_setopt(curl, CURLOPT_CLOSESOCKETDATA, &sockfd);
50.fi
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070051.SH AVAILABILITY
52Added in 7.21.7
53.SH RETURN VALUE
54Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
55.SH "SEE ALSO"
56.BR CURLOPT_CLOSESOCKETFUNCTION "(3), " CURLOPT_OPENSOCKETFUNCTION "(3), "