~ubuntu-branches/ubuntu/warty/curl/warty-security

« back to all changes in this revision

Viewing changes to docs/libcurl/curl_multi_fdset.3

  • Committer: Bazaar Package Importer
  • Author(s): Domenico Andreoli
  • Date: 2004-06-04 19:09:25 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040604190925-wy048bp31320r2z6
Tags: 7.12.0.is.7.11.2-1
* Reverted to version 7.11.2 (closes: #252348).
* Disabled support for libidn (closes: #252367). This is to leave
  curl in unstable as much similar as possible to the one in testing.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" $Id: curl_multi_fdset.3,v 1.8 2004/04/15 15:05:12 bagder Exp $
 
2
.\"
 
3
.TH curl_multi_fdset 3 "15 Apr 2004" "libcurl 7.9.5" "libcurl Manual"
 
4
.SH NAME
 
5
curl_multi_fdset - extracts file descriptor information from a multi handle
 
6
.SH SYNOPSIS
 
7
.nf
 
8
#include <curl/curl.h>
 
9
 
 
10
CURLMcode curl_multi_fdset(CURLM *multi_handle,
 
11
                           fd_set *read_fd_set,
 
12
                           fd_set *write_fd_set,
 
13
                           fd_set *exc_fd_set,
 
14
                           int *max_fd);
 
15
.ad
 
16
.SH DESCRIPTION
 
17
This function extracts file descriptor information from a given multi_handle.
 
18
libcurl returns its fd_set sets. The application can use these to select()
 
19
on. The \fIcurl_multi_perform(3)\fI function should be called as soon as one
 
20
of them are ready to be read from or written to.
 
21
 
 
22
NOTE that once this call is made, you must not remove the sets you point to,
 
23
as libcurl will need to be able to read them. It needs them after select()
 
24
calls, to know if certain sockets are readable or writable.
 
25
 
 
26
You should also be aware that when doing select(), you should consider using a
 
27
rather small (single-digit number of seconds) timeout and call
 
28
\fIcurl_multi_perform\fP regularly - even if no activity has been seen on the
 
29
fd_sets - as otherwise libcurl-internal retries and timeouts may not work as
 
30
you'd think.
 
31
.SH RETURN VALUE
 
32
CURLMcode type, general libcurl multi interface error code. See
 
33
\fIlibcurl-errors(3)\fP
 
34
.SH "SEE ALSO"
 
35
.BR curl_multi_cleanup "(3)," curl_multi_init "(3)"