clarified that you must keep the variables that you point to!
[platform/upstream/curl.git] / docs / libcurl / curl_multi_fdset.3
1 .\" $Id$
2 .\"
3 .TH curl_multi_fdset 3 "3 May 2002" "libcurl 7.9.5" "libcurl Manual"
4 .SH NAME
5 curl_multi_fdset - add an easy handle to a multi session
6 .SH SYNOPSIS
7 #include <curl/curl.h>
8
9 CURLMcode curl_multi_fdset(CURLM *multi_handle,
10                            fd_set *read_fd_set,
11                            fd_set *write_fd_set,
12                            fd_set *exc_fd_set,
13                            int *max_fd);
14 .ad
15 .SH DESCRIPTION
16 This function extracts file descriptor information from a given multi_handle.
17 libcurl returns its fd_set sets. The application can use these to select() or
18 poll() on. The curl_multi_perform() function should be called as soon as one
19 of them are ready to be read from or written to.
20
21 NOTE that once this call is made, you must not remove the sets you point to,
22 as libcurl will need to be able to read them. It needs them after select()
23 calls, to know if certain sockets are readable or writable.
24 .SH RETURN VALUE
25 CURLMcode type, general libcurl multi interface error code.
26 .SH "SEE ALSO"
27 .BR curl_multi_cleanup "(3)," curl_multi_init "(3)"