comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_CLOSESOCKETFUNCTION.3 @ 2:b50eed0cc0ef upstream

ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
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 .\"
23 .TH CURLOPT_CLOSESOCKETFUNCTION 3 "16 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_CLOSESOCKETFUNCTION \- callback to socket close replacement function
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 int closesocket_callback(void *clientp, curl_socket_t item);
30
31 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CLOSESOCKETFUNCTION, closesocket_callback);
32 .SH DESCRIPTION
33 Pass a pointer to your callback function, which should match the prototype
34 shown above.
35
36 This callback function gets called by libcurl instead of the \fIclose(3)\fP or
37 \fIclosesocket(3)\fP call when sockets are closed (not for any other file
38 descriptors). This is pretty much the reverse to the
39 \fICURLOPT_OPENSOCKETFUNCTION(3)\fP option. Return 0 to signal success and 1
40 if there was an error.
41
42 The \fIclientp\fP pointer is set with
43 \fICURLOPT_CLOSESOCKETDATA(3)\fP. \fIitem\fP is the socket libcurl wants to be
44 closed.
45 .SH DEFAULT
46 By default libcurl uses the standard socket close function.
47 .SH PROTOCOLS
48 All
49 .SH EXAMPLE
50 .nf
51 static int closesocket(void *clientp, curl_socket_t item)
52 {
53 printf("libcurl wants to close %d now\\n", (int)item);
54 return 0;
55 }
56
57 /* call this function to close sockets */
58 curl_easy_setopt(curl, CURLOPT_CLOSESOCKETFUNCTION, closesocket);
59 curl_easy_setopt(curl, CURLOPT_CLOSESOCKETDATA, &sockfd);
60 .fi
61 .SH AVAILABILITY
62 Added in 7.21.7
63 .SH RETURN VALUE
64 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
65 .SH "SEE ALSO"
66 .BR CURLOPT_CLOSESOCKETDATA "(3), " CURLOPT_OPENSOCKETFUNCTION "(3), "