mingw/share/man/man3/curl_multi_timeout.3

   1 .\" $Id: curl_multi_timeout.3,v 1.3 2006-06-24 21:49:40 bagder Exp $
   2 .\"
   3 .TH curl_multi_timeout 3 "2 Jan 2006" "libcurl 7.16.0" "libcurl Manual"
   4 .SH NAME
   5 curl_multi_timeout \- how long to wait for action before proceeding
   6 .SH SYNOPSIS
   7 #include <curl/curl.h>
   8
   9 CURLMcode curl_multi_timeout(CURLM *multi_handle, long *timeout);
  10 .SH DESCRIPTION
  11
  12 An application using the libcurl multi interface should call
  13 \fBcurl_multi_timeout(3)\fP to figure out how long it should wait for socket
  14 actions \- at most \- before proceeding.
  15
  16 Proceeding means either doing the socket-style timeout action: call the
  17 \fBcurl_multi_socket(3)\fP function with the \fBsockfd\fP argument set to
  18 CURL_SOCKET_TIMEOUT and the \fBeasy\fP argument set to CURL_EASY_TIMEOUT, or
  19 simply calling \fBcurl_multi_perform(3)\fP if you're using the simpler and
  20 older multi interface approach.
  21
  22 The timeout value returned in the long \fBtimeout\fP points to, is in number
  23 of milliseconds at this very moment. If 0, it means you should proceed
  24 immediately without waiting for anything. If it returns -1, there's no timeout
  25 at all set.
  26 .SH "RETURN VALUE"
  27 The standard CURLMcode for multi interface error codes.
  28 .SH "TYPICAL USAGE"
  29 Call \fBcurl_multi_timeout(3)\fP, then wait for action on the sockets. You
  30 figure out which sockets to wait for by calling \fBcurl_multi_fdset(3)\fP or
  31 by a previous call to \fBcurl_multi_socket(3)\fP.
  32 .SH AVAILABILITY
  33 This function was added in libcurl 7.15.4, although not deemed stable yet.
  34 .SH "SEE ALSO"
  35 .BR curl_multi_cleanup "(3), " curl_multi_init "(3), "
  36 .BR curl_multi_fdset "(3), " curl_multi_info_read "(3), "
  37 .BR curl_multi_socket "(3) "
  38