comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLMOPT_TIMERDATA.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 CURLMOPT_TIMERDATA 3 "17 Jun 2014" "libcurl 7.37.0" "curl_multi_setopt options"
24 .SH NAME
25 CURLMOPT_TIMERDATA \- custom pointer to pass to timer callback
26 .SH SYNOPSIS
27 .nf
28 #include <curl/curl.h>
29
30 CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_TIMERDATA, void *pointer);
31 .SH DESCRIPTION
32 A data \fBpointer\fP to pass to the timer callback set with the
33 \fICURLMOPT_TIMERFUNCTION(3)\fP option.
34
35 This pointer will not be touched by libcurl but will only be passed in to the
36 timer callbacks's \fBuserp\fP argument.
37 .SH DEFAULT
38 NULL
39 .SH PROTOCOLS
40 All
41 .SH EXAMPLE
42 .nf
43 static gboolean timeout_cb(gpointer user_data)
44 {
45 int running;
46 if(user_data) {
47 g_free(user_data);
48 curl_multi_setopt(curl_handle, CURLMOPT_TIMERDATA, NULL);
49 }
50 curl_multi_socket_action(multi, CURL_SOCKET_TIMEOUT, 0, &running);
51 return G_SOURCE_REMOVE;
52 }
53
54 static int timerfunc(CURLM *multi, long timeout_ms, void *userp)
55 {
56 guint *id = userp;
57
58 if(id)
59 g_source_remove(*id);
60
61 /* -1 means we should just delete our timer. */
62 if(timeout_ms == -1) {
63 g_free(id);
64 id = NULL;
65 }
66 else {
67 if(!id)
68 id = g_new(guint, 1);
69 *id = g_timeout_add(timeout_ms, timeout_cb, id);
70 }
71 curl_multi_setopt(multi, CURLMOPT_TIMERDATA, id);
72 return 0;
73 }
74
75 curl_multi_setopt(multi, CURLMOPT_TIMERFUNCTION, timerfunc);
76 .fi
77 .SH AVAILABILITY
78 Added in 7.16.0
79 .SH RETURN VALUE
80 Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
81 .SH "SEE ALSO"
82 .BR CURLMOPT_TIMERFUNCTION "(3), " CURLMOPT_SOCKETFUNCTION "(3), "