docs/libcurl/opts/CURLMOPT_TIMERFUNCTION.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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_TIMERFUNCTION 3 "17 Jun 2014" "libcurl 7.37.0" "curl_multi_setopt options"
  24 .SH NAME
  25 CURLMOPT_TIMERFUNCTION \- set callback to receive timeout values
  26 .SH SYNOPSIS
  27 .nf
  28 #include <curl/curl.h>
  29
  30 int timer_callback(CURLM *multi,    /* multi handle */
  31                    long timeout_ms, /* see above */
  32                    void *userp);    /* private callback pointer */
  33
  34 CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_TIMERFUNCTION, timer_callback);
  35 .SH DESCRIPTION
  36 Pass a pointer to your callback function, which should match the prototype
  37 shown above.
  38
  39 This callback function will be called when the timeout value changes. The
  40 \fBtimeout_ms\fP value is at what latest time the application should call one
  41 of the \&"performing" functions of the multi interface
  42 (\fIcurl_multi_socket_action(3)\fP and \fIcurl_multi_perform(3)\fP) - to allow
  43 libcurl to keep timeouts and retries etc to work. A \fBtimeout_ms\fP value of
  44 -1 means that there is no timeout at all, and 0 means that the timeout is
  45 already expired. libcurl attempts to limit calling this only when the fixed
  46 future timeout time actually changes.
  47
  48 The \fBuserp\fP pointer is set with \fICURLMOPT_TIMERDATA(3)\fP.
  49
  50 The timer callback should return 0 on success, and -1 on error. This callback
  51 can be used instead of, or in addition to, \fIcurl_multi_timeout(3)\fP.
  52 .SH DEFAULT
  53 NULL
  54 .SH PROTOCOLS
  55 All
  56 .SH EXAMPLE
  57 TODO
  58 .SH AVAILABILITY
  59 Added in 7.16.0
  60 .SH RETURN VALUE
  61 Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  62 .SH "SEE ALSO"
  63 .BR CURLMOPT_TIMERDATA "(3), " CURLMOPT_SOCKETFUNCTION "(3), "