moparisthebest
/
curl
mirror of https://github.com/moparisthebest/curl
1
0
Fork 0
Code Issues Releases Wiki Activity

I removed the timeout argument from the socket callback and did some other 

cleanups of this man page. The lengthy description has now also been removed
from curl/multi.h since it immediately got tedious to maintain the info on
two places when I did major updates...
This commit is contained in:
Daniel Stenberg 2006-01-02 22:58:56 +00:00
parent 4dcb930247
commit fa18d6fb76
1 changed files with 25 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/libcurl/curl_multi_socket.3
View File

@ -2,7 +2,7 @@
.\" .\"
.TH curl_multi_socket 3 "21 Dec 2005" "libcurl 7.16.0" "libcurl Manual" .TH curl_multi_socket 3 "21 Dec 2005" "libcurl 7.16.0" "libcurl Manual"
.SH NAME .SH NAME
curl_multi_socket - reads/writes available data curl_multi_socket \- reads/writes available data
.SH SYNOPSIS .SH SYNOPSIS
#include <curl/curl.h> #include <curl/curl.h>
@ -32,23 +32,31 @@ status with changes since the previous time this function was used. If
\fBcallback\fP is NULL, no callback will be called. A status change may also \fBcallback\fP is NULL, no callback will be called. A status change may also
be a new timeout only, having the same IN/OUT status as before. be a new timeout only, having the same IN/OUT status as before.
If a previous wait for socket action(s) timed out, you should call this If you want to force libcurl to (re-)check all its internal sockets and
function with the socket argument set to CURL_SOCKET_TIMEOUT. If you want to transfers instead of just a single one, you call
force libcurl to (re-)check all its internal sockets, and call the callback \fBcurl_multi_socket_all(3)\fP instead.
with status for all sockets no matter what the previous state is, you call
curl_multi_socket_all() instead.
curl_multi_perform() is the equivalent of calling An application should call \fBcurl_multi_timeout(3)\fP to figure out how long
curl_multi_socket_all(handle, NULL, NULL); it should wait for socket actions \- at most \- before doing the 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.
Regarding the timeout argument in the callback: it is the timeout (in \fBcurl_multi_perform(3)\fP is the exact equivalent of calling
milliseconds) for waiting on action on this socket (and the given time period \fBcurl_multi_socket_all\fP(handle, NULL, NULL);
starts when the callback is called) until you should call curl_multi_socket()
with the timeout stuff mentioned above. If "actions" happens on the socket
before the timeout happens, remember that the timout timer keeps ticking until
told otherwise.
The "what" argument has one of five values: The socket \fBcallback\fP function uses a prototype like this
.nf
int curl_socket_callback(CURL *easy, /* easy handle */
curl_socket_t s, /* socket */
int action, /* see values below */
void *userp); /* "private" pointer */
.fi
The callback MUST return 0.
The \fIaction\fP (third) argument to the callback has one of five values:
.RS .RS
.IP "CURL_POLL_NONE (0)" .IP "CURL_POLL_NONE (0)"
register, not interested in readiness (yet) register, not interested in readiness (yet)
@ -77,6 +85,8 @@ function returns OK.
Call curl_multi_socket_all() first. Setup a "collection" of sockets to Call curl_multi_socket_all() first. Setup a "collection" of sockets to
supervise, then when action happens call curl_multi_socket() for the easy supervise, then when action happens call curl_multi_socket() for the easy
handle that got the action. handle that got the action.
.SH AVAILABILITY
This function was added in libcurl 7.16.0
.SH "SEE ALSO" .SH "SEE ALSO"
.BR curl_multi_cleanup "(3), " curl_multi_init "(3), " .BR curl_multi_cleanup "(3), " curl_multi_init "(3), "
.BR curl_multi_fdset "(3), " curl_multi_info_read "(3)" .BR curl_multi_fdset "(3), " curl_multi_info_read "(3)"