| .\" ************************************************************************** |
| .\" * _ _ ____ _ |
| .\" * Project ___| | | | _ \| | |
| .\" * / __| | | | |_) | | |
| .\" * | (__| |_| | _ <| |___ |
| .\" * \___|\___/|_| \_\_____| |
| .\" * |
| .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al. |
| .\" * |
| .\" * This software is licensed as described in the file COPYING, which |
| .\" * you should have received as part of this distribution. The terms |
| .\" * are also available at https://curl.se/docs/copyright.html. |
| .\" * |
| .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| .\" * copies of the Software, and permit persons to whom the Software is |
| .\" * furnished to do so, under the terms of the COPYING file. |
| .\" * |
| .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| .\" * KIND, either express or implied. |
| .\" * |
| .\" ************************************************************************** |
| .\" |
| .TH CURLMOPT_TIMERDATA 3 "November 04, 2020" "libcurl 7.78.0" "curl_multi_setopt options" |
| |
| .SH NAME |
| CURLMOPT_TIMERDATA \- custom pointer to pass to timer callback |
| .SH SYNOPSIS |
| .nf |
| #include <curl/curl.h> |
| |
| CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_TIMERDATA, void *pointer); |
| .SH DESCRIPTION |
| A data \fBpointer\fP to pass to the timer callback set with the |
| \fICURLMOPT_TIMERFUNCTION(3)\fP option. |
| |
| This pointer will not be touched by libcurl but will only be passed in to the |
| timer callbacks's \fBuserp\fP argument. |
| .SH DEFAULT |
| NULL |
| .SH PROTOCOLS |
| All |
| .SH EXAMPLE |
| .nf |
| static gboolean timeout_cb(gpointer user_data) |
| { |
| int running; |
| if(user_data) { |
| g_free(user_data); |
| curl_multi_setopt(curl_handle, CURLMOPT_TIMERDATA, NULL); |
| } |
| curl_multi_socket_action(multi, CURL_SOCKET_TIMEOUT, 0, &running); |
| return G_SOURCE_REMOVE; |
| } |
| |
| static int timerfunc(CURLM *multi, long timeout_ms, void *userp) |
| { |
| guint *id = userp; |
| |
| if(id) |
| g_source_remove(*id); |
| |
| /* -1 means we should just delete our timer. */ |
| if(timeout_ms == -1) { |
| g_free(id); |
| id = NULL; |
| } |
| else { |
| if(!id) |
| id = g_new(guint, 1); |
| *id = g_timeout_add(timeout_ms, timeout_cb, id); |
| } |
| curl_multi_setopt(multi, CURLMOPT_TIMERDATA, id); |
| return 0; |
| } |
| |
| curl_multi_setopt(multi, CURLMOPT_TIMERFUNCTION, timerfunc); |
| .fi |
| .SH AVAILABILITY |
| Added in 7.16.0 |
| .SH RETURN VALUE |
| Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
| .SH "SEE ALSO" |
| .BR CURLMOPT_TIMERFUNCTION "(3), " CURLMOPT_SOCKETFUNCTION "(3), " |
