From 58d2e7c6d11e1f5b454a6f72ba8b318fe9bd1b40 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Mon, 2 Jan 2006 23:00:04 +0000 Subject: [PATCH] Initial description of the upcoming curl_multi_timeout() function --- docs/libcurl/curl_multi_timeout.3 | 35 +++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 docs/libcurl/curl_multi_timeout.3 diff --git a/docs/libcurl/curl_multi_timeout.3 b/docs/libcurl/curl_multi_timeout.3 new file mode 100644 index 000000000..636520f5c --- /dev/null +++ b/docs/libcurl/curl_multi_timeout.3 @@ -0,0 +1,35 @@ +.\" $Id$ +.\" +.TH curl_multi_timeout 3 "2 Jan 2006" "libcurl 7.16.0" "libcurl Manual" +.SH NAME +curl_multi_timeout \- how long to wait for action before proceeding +.SH SYNOPSIS +#include + +long curl_multi_timeout(CURLM *multi_handle); +.SH DESCRIPTION + +An application using the libcurl multi interface should call +\fBcurl_multi_timeout(3)\fP 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 +\fBcurl_multi_socket(3)\fP function with the \fBsockfd\fP argument set to +CURL_SOCKET_TIMEOUT and the \fBeasy\fP argument set to CURL_EASY_TIMEOUT, or +simply calling \fBcurl_multi_perform(3)\fP if you're using the simpler and +older multi interface approach. + +.SH "RETURN VALUE" +The timeout value in number of milliseconds. If 0, it means you should proceed +immediately without waiting for anything. +.SH "TYPICAL USAGE" +Call \fBcurl_multi_timeout(3)\fP, then wait for action on the sockets. You +figure out which sockets to wait for by calling \fBcurl_multi_fdset(3)\fP or +by a previous call to \fBcurl_multi_socket(3)\fP. +.SH AVAILABILITY +This function was added in libcurl 7.16.0 +.SH "SEE ALSO" +.BR curl_multi_cleanup "(3), " curl_multi_init "(3), " +.BR curl_multi_fdset "(3), " curl_multi_info_read "(3), " +.BR curl_multi_socket "(3) " +