curl_multi_timeout - how long to wait for action before proceeding
#include <curl/curl.h> CURLMcode curl_multi_timeout(CURLM *multi_handle, long *timeout);
curl_multi_timeout(3) libcurl Manual curl_multi_timeout(3) NAME curl_multi_timeout - how long to wait for action before proceeding SYNOPSIS #include <curl/curl.h> CURLMcode curl_multi_timeout(CURLM *multi_handle, long *timeout); DESCRIPTION An application using the libcurl multi interface should call curl_multi_timeout(3) to figure out how long it should wait for socket actions - at most - before proceeding. Proceeding means either doing the socket-style timeout action: call the curl_multi_socket_action(3) function with the sockfd argument set to CURL_SOCKET_TIMEOUT, or call curl_multi_perform(3) if you are using the simpler and older multi interface approach. The timeout value returned in the long timeout points to, is in number of milliseconds at this moment. If 0, it means you should proceed imme- diately without waiting for anything. If it returns -1, there's no timeout at all set. An application that uses the multi_socket API SHOULD NOT use this func- tion, but SHOULD instead use curl_multi_setopt(3) and its CURL- MOPT_TIMERFUNCTION option for proper and desired behavior. Note: if libcurl returns a -1 timeout here, it just means that libcurl currently has no stored timeout value. You must not wait too long (more than a few seconds perhaps) before you call curl_multi_perform() again. EXAMPLE struct timeval timeout; long timeo; curl_multi_timeout(multi_handle, &timeo); if(timeo < 0) /* no set timeout, use a default */ timeo = 980; timeout.tv_sec = timeo / 1000; timeout.tv_usec = (timeo % 1000) * 1000; /* wait for activities no longer than the set timeout */ select(maxfd+1, &fdread, &fdwrite, &fdexcep, &timeout); TYPICAL USAGE Call curl_multi_timeout(3), then wait for action on the sockets. You figure out which sockets to wait for by calling curl_multi_fdset(3) or by a previous call to curl_multi_socket(3). AVAILABILITY This function was added in libcurl 7.15.4. RETURN VALUE The standard CURLMcode for multi interface error codes. ATTRIBUTES See attributes(7) for descriptions of the following attributes: +---------------+------------------+ |ATTRIBUTE TYPE | ATTRIBUTE VALUE | +---------------+------------------+ |Availability | web/curl | +---------------+------------------+ |Stability | Uncommitted | +---------------+------------------+ SEE ALSO curl_multi_fdset(3), curl_multi_info_read(3), curl_multi_socket(3), curl_multi_setopt(3) NOTES Source code for open source software components in Oracle Solaris can be found at https://www.oracle.com/downloads/opensource/solaris-source- code-downloads.html. This software was built from source available at https://github.com/oracle/solaris-userland. The original community source was downloaded from https://curl.se/down- load/curl-7.83.1.tar.bz2. Further information about this software can be found on the open source community website at http://curl.haxx.se/. libcurl 7.83.1 November 26, 2021 curl_multi_timeout(3)