diff options
Diffstat (limited to 'plugins/FTPFileYM/curl-7.29.0/docs/libcurl/curl_multi_wait.3')
| -rw-r--r-- | plugins/FTPFileYM/curl-7.29.0/docs/libcurl/curl_multi_wait.3 | 75 |
1 files changed, 0 insertions, 75 deletions
diff --git a/plugins/FTPFileYM/curl-7.29.0/docs/libcurl/curl_multi_wait.3 b/plugins/FTPFileYM/curl-7.29.0/docs/libcurl/curl_multi_wait.3 deleted file mode 100644 index b14760bf3f..0000000000 --- a/plugins/FTPFileYM/curl-7.29.0/docs/libcurl/curl_multi_wait.3 +++ /dev/null @@ -1,75 +0,0 @@ -.\" ************************************************************************** -.\" * _ _ ____ _ -.\" * Project ___| | | | _ \| | -.\" * / __| | | | |_) | | -.\" * | (__| |_| | _ <| |___ -.\" * \___|\___/|_| \_\_____| -.\" * -.\" * Copyright (C) 1998 - 2012, Daniel Stenberg, <daniel@haxx.se>, et al. -.\" * -.\" * This software is licensed as described in the file COPYING, which -.\" * you should have received as part of this distribution. The terms -.\" * are also available at http://curl.haxx.se/docs/copyright.html. -.\" * -.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell -.\" * copies of the Software, and permit persons to whom the Software is -.\" * furnished to do so, under the terms of the COPYING file. -.\" * -.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY -.\" * KIND, either express or implied. -.\" * -.\" ************************************************************************** -.TH curl_multi_wait 3 "12 Jul 2012" "libcurl 7.28.0" "libcurl Manual" -.SH NAME -curl_multi_wait - polls on all easy handles in a multi handle -.SH SYNOPSIS -.nf -#include <curl/curl.h> - -CURLMcode curl_multi_wait(CURLM *multi_handle, - struct curl_waitfd extra_fds[], - unsigned int extra_nfds, - int timeout_ms, - int *numfds); -.ad -.SH DESCRIPTION -This function polls on all file descriptors used by the curl easy handles -contained in the given multi handle set. It will block until activity is -detected on at least one of the handles or \fItimeout_ms\fP has passed. - -The calling application may pass additional curl_waitfd structures which are -similar to \fIpoll(2)\fP's pollfd structure to be waited on in the same call. - -On completion, if \fInumfds\fP is supplied, it will be populated with the -number of file descriptors on which interesting events occured. - -If no extra file descriptors are provided and libcurl has no file descriptor -to offer to wait for, this function will return immediately. - -This function is encouraged to be used instead of select(3) when using the -multi interface to allow applications to easier circumvent the common problem -with 1024 maximum file descriptors. -.SH curl_waitfd -.nf -struct curl_waitfd { - curl_socket_t fd; - short events; - short revents; -}; -.fi -.IP CURL_WAIT_POLLIN -Bit flag to curl_waitfd.events indicating the socket should poll on read -events such as new data received. -.IP CURL_WAIT_POLLPRI -Bit flag to curl_waitfd.events indicating the socket should poll on high -priority read events such as out of band data. -.IP CURL_WAIT_POLLOUT -Bit flag to curl_waitfd.events indicating the socket should poll on write -events such as the socket being clear to write without blocking. -.SH RETURN VALUE -CURLMcode type, general libcurl multi interface error code. See -\fIlibcurl-errors(3)\fP -.SH AVAILABILITY -This function was added in libcurl 7.28.0. -.SH "SEE ALSO" -.BR curl_multi_fdset "(3), " curl_multi_perform "(3)" |