comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_SOCKOPTDATA.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_SOCKOPTDATA 3 "16 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_SOCKOPTDATA \- custom pointer to pass to sockopt callback
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKOPTDATA, void *pointer);
30 .SH DESCRIPTION
31 Pass a \fIpointer\fP that will be untouched by libcurl and passed as the first
32 argument in the sockopt callback set with \fICURLOPT_SOCKOPTFUNCTION(3)\fP.
33 .SH DEFAULT
34 The default value of this parameter is NULL.
35 .SH PROTOCOLS
36 All
37 .SH EXAMPLE
38 .nf
39 static int sockopt_callback(void *clientp, curl_socket_t curlfd,
40 curlsocktype purpose)
41 {
42 int val = *(int *)clientp;
43 setsockopt(curldfd, SOL_SOCKET, SO_RCVBUF, (const char *)&val, sizeof(val));
44 return CURL_SOCKOPT_OK;
45 }
46
47 curl = curl_easy_init();
48 if(curl) {
49 int recvbuffersize = 256 * 1024;
50
51 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/");
52
53 /* call this function to set options for the socket */
54 curl_easy_setopt(curl, CURLOPT_SOCKOPTFUNCTION, sockopt_callback);
55 curl_easy_setopt(curl, CURLOPT_SOCKOPTDATA, &recvbuffersize);
56
57 res = curl_easy_perform(curl);
58
59 curl_easy_cleanup(curl);
60 }
61 .fi
62 .SH AVAILABILITY
63 Added in 7.16.0
64 .SH RETURN VALUE
65 Returns \fICURLE_OK\fP if the option is supported, and \fICURLE_UNKNOWN_OPTION\fP if not.
66 .SH "SEE ALSO"
67 .BR CURLOPT_SOCKOPTFUNCTION "(3), " CURLOPT_OPENSOCKETFUNCTION "(3), "