1curl_multi_timeout(3)           libcurl Manual           curl_multi_timeout(3)
2
3
4

NAME

6       curl_multi_timeout - how long to wait for action before proceeding
7

SYNOPSIS

9       #include <curl/curl.h>
10
11       CURLMcode curl_multi_timeout(CURLM *multi_handle, long *timeout);
12

DESCRIPTION

14       An   application   using   the  libcurl  multi  interface  should  call
15       curl_multi_timeout(3) to figure out how long it should wait for  socket
16       actions - at most - before proceeding.
17
18       Proceeding means either doing the socket-style timeout action: call the
19       curl_multi_socket(3)  function  with  the  sockfd   argument   set   to
20       CURL_SOCKET_TIMEOUT  and the easy argument set to CURL_EASY_TIMEOUT, or
21       simply calling curl_multi_perform(3) if you're using  the  simpler  and
22       older multi interface approach.
23
24       The  timeout value returned in the long timeout points to, is in number
25       of milliseconds at this very moment. If 0, it means you should  proceed
26       immediately  without waiting for anything. If it returns -1, there's no
27       timeout at all set.
28

RETURN VALUE

30       The standard CURLMcode for multi interface error codes.
31

TYPICAL USAGE

33       Call curl_multi_timeout(3), then wait for action on  the  sockets.  You
34       figure  out which sockets to wait for by calling curl_multi_fdset(3) or
35       by a previous call to curl_multi_socket(3).
36

AVAILABILITY

38       This function was added in libcurl 7.15.4, although not  deemed  stable
39       yet.
40

SEE ALSO

42       curl_multi_cleanup(3),     curl_multi_init(3),     curl_multi_fdset(3),
43       curl_multi_info_read(3), curl_multi_socket(3)
44
45
46
47
48libcurl 7.16.0                    2 Jan 2006             curl_multi_timeout(3)
Impressum