1curl_multi_timeout(3) libcurl Manual curl_multi_timeout(3)
2
3
4
6 curl_multi_timeout - how long to wait for action before proceeding
7
9 #include <curl/curl.h>
10
11 CURLMcode curl_multi_timeout(CURLM *multi_handle, long *timeout);
12
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_action(3) function with the sockfd argument set to
20 CURL_SOCKET_TIMEOUT, or call curl_multi_perform(3) if you're using the
21 simpler and older multi interface approach.
22
23 The timeout value returned in the long timeout points to, is in number
24 of milliseconds at this very moment. If 0, it means you should proceed
25 immediately without waiting for anything. If it returns -1, there's no
26 timeout at all set.
27
28 An application that uses the multi_socket API SHOULD not use this func‐
29 tion, but SHOULD instead use curl_multi_setopt(3) and its CURL‐
30 MOPT_TIMERFUNCTION option for proper and desired behavior.
31
32 Note: if libcurl returns a -1 timeout here, it just means that libcurl
33 currently has no stored timeout value. You must not wait too long (more
34 than a few seconds perhaps) before you call curl_multi_perform() again.
35
37 The standard CURLMcode for multi interface error codes.
38
40 Call curl_multi_timeout(3), then wait for action on the sockets. You
41 figure out which sockets to wait for by calling curl_multi_fdset(3) or
42 by a previous call to curl_multi_socket(3).
43
45 This function was added in libcurl 7.15.4.
46
48 curl_multi_fdset(3), curl_multi_info_read(3), curl_multi_socket(3),
49 curl_multi_setopt(3)
50
51
52
53
54libcurl 7.16.0 2 Jan 2006 curl_multi_timeout(3)