docs/libcurl/opts/CURLMOPT_TIMERFUNCTION.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2  "http://www.w3.org/TR/html4/loose.dtd">
   3 <html><head>
   4 <title>CURLMOPT_TIMERFUNCTION man page</title>
   5 <meta name="generator" content="roffit">
   6 <STYLE type="text/css">
   7 pre {
   8   overflow: auto;
   9   margin: 0;
  10 }
  11
  12 P.level0, pre.level0 {
  13  padding-left: 2em;
  14 }
  15
  16 P.level1, pre.level1 {
  17  padding-left: 4em;
  18 }
  19
  20 P.level2, pre.level2 {
  21  padding-left: 6em;
  22 }
  23
  24 span.emphasis {
  25  font-style: italic;
  26 }
  27
  28 span.bold {
  29  font-weight: bold;
  30 }
  31
  32 span.manpage {
  33  font-weight: bold;
  34 }
  35
  36 h2.nroffsh {
  37  background-color: #e0e0e0;
  38 }
  39
  40 span.nroffip {
  41  font-weight: bold;
  42  font-size: 120%;
  43  font-family: monospace;
  44 }
  45
  46 p.roffit {
  47  text-align: center;
  48  font-size: 80%;
  49 }
  50 </STYLE>
  51 </head><body>
  52
  53 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
  54 <p class="level0">CURLMOPT_TIMERFUNCTION - set callback to receive timeout values <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
  55 <p class="level0"><pre class="level0">
  56 &#35;include &lt;curl/curl.h&gt;
  57 &nbsp;
  58 int timer_callback(CURLM *multi,    /* multi handle */
  59 &nbsp;                  long timeout_ms, /* see above */
  60 &nbsp;                  void *userp);    /* private callback pointer */
  61 &nbsp;
  62 CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_TIMERFUNCTION, timer_callback);
  63 </pre>
  64 <a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
  65 <p class="level0">Pass a pointer to your callback function, which should match the prototype shown above.
  66 <p class="level0">Certain features, such as timeouts and retries, require you to call libcurl even when there is no activity on the file descriptors.
  67 <p class="level0">Your callback function <span Class="bold">timer_callback</span> should install a non-repeating timer with an interval of <span Class="bold">timeout_ms</span>. Each time that timer fires, call either <span Class="emphasis">curl_multi_socket_action(3)</span> or <span Class="emphasis">curl_multi_perform(3)</span>, depending on which interface you use.
  68 <p class="level0">A <span Class="bold">timeout_ms</span> value of -1 means you should delete your timer.
  69 <p class="level0">A <span Class="bold">timeout_ms</span> value of 0 means you should call <span Class="emphasis">curl_multi_socket_action(3)</span> or <span Class="emphasis">curl_multi_perform(3)</span> (once) as soon as possible.
  70 <p class="level0"><span Class="bold">timer_callback</span> will only be called when the <span Class="bold">timeout_ms</span> changes.
  71 <p class="level0">The <span Class="bold">userp</span> pointer is set with <a Class="emphasis" href="./CURLMOPT_TIMERDATA.html">CURLMOPT_TIMERDATA</a>.
  72 <p class="level0">The timer callback should return 0 on success, and -1 on error. This callback can be used instead of, or in addition to, <span Class="emphasis">curl_multi_timeout(3)</span>. <a name="DEFAULT"></a><h2 class="nroffsh">DEFAULT</h2>
  73 <p class="level0">NULL <a name="PROTOCOLS"></a><h2 class="nroffsh">PROTOCOLS</h2>
  74 <p class="level0">All <a name="EXAMPLE"></a><h2 class="nroffsh">EXAMPLE</h2>
  75 <p class="level0"><pre class="level0">
  76 static gboolean timeout_cb(gpointer user_data) {
  77 &nbsp;   if (user_data) {
  78 &nbsp;       g_free(user_data);
  79 &nbsp;       curl_multi_setopt(curl_handle, CURLMOPT_TIMERDATA, NULL);
  80 &nbsp;   }
  81 &nbsp;   int running;
  82 &nbsp;   curl_multi_socket_action(multi, CURL_SOCKET_TIMEOUT, 0, &running);
  83 &nbsp;   return G_SOURCE_REMOVE;
  84 }
  85 &nbsp;
  86 static int timerfunc(CURLM *multi, long timeout_ms, void *userp) {
  87 &nbsp;   guint *id = userp;
  88 &nbsp;
  89 &nbsp;   if (id)
  90 &nbsp;       g_source_remove(*id);
  91 &nbsp;
  92 &nbsp;   // -1 means we should just delete our timer.
  93 &nbsp;   if (timeout_ms == -1) {
  94 &nbsp;       g_free(id);
  95 &nbsp;       id = NULL;
  96 &nbsp;   } else {
  97 &nbsp;       if (!id)
  98 &nbsp;           id = g_new(guint, 1);
  99 &nbsp;       *id = g_timeout_add(timeout_ms, timeout_cb, id);
 100 &nbsp;   }
 101 &nbsp;   curl_multi_setopt(multi, CURLMOPT_TIMERDATA, id);
 102 &nbsp;   return 0;
 103 }
 104 &nbsp;
 105 curl_multi_setopt(multi, CURLMOPT_TIMERFUNCTION, timerfunc);
 106 </pre>
 107
 108 <p class="level0"><a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
 109 <p class="level0">Added in 7.16.0 <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
 110 <p class="level0">Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
 111 <p class="level0"><a Class="manpage" href="./CURLMOPT_TIMERDATA.html">CURLMOPT_TIMERDATA</a>, <a Class="manpage" href="./CURLMOPT_SOCKETFUNCTION.html">CURLMOPT_SOCKETFUNCTION</a><p class="roffit">
 112  This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
 113 </body></html>