moparisthebest/curl
1
0
Fork 0
mirror of https://github.com/moparisthebest/curl synced 2024-11-12 04:25:08 -05:00
Code Issues Releases Wiki Activity

updated docs with the new parameter

Browse Source
This commit is contained in:
Daniel Stenberg 2006-08-01 08:57:32 +00:00
parent ae8a01ead6
commit 825a526789
1 changed files with 25 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/libcurl/curl_multi_socket.3
View File

@ -6,26 +6,38 @@ curl_multi_socket \- reads/writes available data
.SH SYNOPSIS .SH SYNOPSIS
#include <curl/curl.h> #include <curl/curl.h>
CURLMcode curl_multi_socket(CURLM * multi_handle, curl_socket_t sockfd); CURLMcode curl_multi_socket(CURLM * multi_handle, curl_socket_t sockfd,
int *running_handles);
CURLMcode curl_multi_socket_all(CURLM *multi_handle); CURLMcode curl_multi_socket_all(CURLM *multi_handle,
int *running_handles);
.SH DESCRIPTION .SH DESCRIPTION
Alternative versions of \fIcurl_multi_perform()\fP that allows the application Alternative versions of \fIcurl_multi_perform(3)\fP that allows the
to pass in one of the file descriptors/sockets that have been detected to have application to pass in one of the file descriptors/sockets that have been
\&"action" on them and let libcurl perform. This allows libcurl to not have to detected to have \&"action" on them and let libcurl perform. This allows
scan through all possible file descriptors to check for action. When the libcurl to not have to scan through all possible file descriptors to check for
application has detected action on a socket handled by libcurl, it should call action. When the application has detected action on a socket handled by
\fIcurl_multi_perform()\fP with the \fBsockfd\fP argument set to the socket libcurl, it should call \fIcurl_multi_socket(3)\fP with the \fBsockfd\fP
with the action. argument set to the socket with the action.
These functions inform the application about updates in the socket (file At return, the int \fBrunning_handles\fP points to will contain the number of
descriptor) status by doing none, one or multiple calls to the callback still running easy handles within the multi handle. When this number reaches
function set with the CURLMOPT_SOCKETFUNCTION option to zero, all transfers are complete/done. Note that when you call
\fIcurl_multi_socket(3)\fP on a specific socket and the counter decreases by
one, it DOES NOT necessarily mean that this exact socket/transfer is the one
that completed. Use \fIcurl_multi_info_read(3)\fP to figure out which easy
handle that completed.
The curl_multi_socket functions inform the application about updates in the
socket (file descriptor) status by doing none, one or multiple calls to the
socket callback function set with the CURLMOPT_SOCKETFUNCTION option to
\fIcurl_multi_setopt(3)\fP. They update the status with changes since the \fIcurl_multi_setopt(3)\fP. They update the status with changes since the
previous time this function was called. previous time this function was called.
To force libcurl to (re-)check all its internal sockets and transfers instead To force libcurl to (re-)check all its internal sockets and transfers instead
of just a single one, you call \fBcurl_multi_socket_all(3)\fP. of just a single one, you call \fBcurl_multi_socket_all(3)\fP. This is
typically done as the first function call before the application has any
knowledge about what sockets libcurl uses.
Applications should call \fBcurl_multi_timeout(3)\fP to figure out how long to Applications should call \fBcurl_multi_timeout(3)\fP to figure out how long to
wait for socket actions \- at most \- before doing the timeout action: call wait for socket actions \- at most \- before doing the timeout action: call