moparisthebest/curl
1
0
Fork 0
mirror of https://github.com/moparisthebest/curl synced 2024-08-13 17:03:50 -04:00
Code Issues Releases Wiki Activity

Christopher Palow's multi interface docs updates

Browse Source
This commit is contained in:
Daniel Stenberg 2008-05-24 19:19:49 +00:00
parent a9a05a32bd
commit 89977c73d1
2 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/libcurl/curl_multi_add_handle.3
View File

@ -11,6 +11,8 @@ CURLMcode curl_multi_add_handle(CURLM *multi_handle, CURL *easy_handle);
.SH DESCRIPTION .SH DESCRIPTION
Adds a standard easy handle to the multi stack. This function call will make Adds a standard easy handle to the multi stack. This function call will make
this \fImulti_handle\fP control the specified \fIeasy_handle\fP. this \fImulti_handle\fP control the specified \fIeasy_handle\fP.
Furthermore, libcurl now initiates the connection associated with the
specified \fIeasy_handle\fP.
When an easy handle has been added to a multi stack, you can not and you must When an easy handle has been added to a multi stack, you can not and you must
not use \fIcurl_easy_perform(3)\fP on that handle! not use \fIcurl_easy_perform(3)\fP on that handle!

19
docs/libcurl/curl_multi_socket.3
View File

@ -46,9 +46,8 @@ socket callback function set with the CURLMOPT_SOCKETFUNCTION option to
previous time this function was called. previous time this function was called.
Force libcurl to (re-)check all its internal sockets and transfers instead of Force libcurl to (re-)check all its internal sockets and transfers instead of
just a single one by calling \fBcurl_multi_socket_all(3)\fP. This is typically just a single one by calling \fBcurl_multi_socket_all(3)\fP. Note that there
done as the first function call before the application has any knowledge about should rarely be reasons to use this function!
what sockets libcurl uses.
Get the timeout time - how long to wait for socket actions at most before Get the timeout time - how long to wait for socket actions at most before
doing the timeout action: call the \fBcurl_multi_socket(3)\fP function with doing the timeout action: call the \fBcurl_multi_socket(3)\fP function with
@ -125,22 +124,20 @@ function returns OK.
3. Set the timeout callback with CURLMOPT_TIMERFUNCTION, to get to know what 3. Set the timeout callback with CURLMOPT_TIMERFUNCTION, to get to know what
timeout value to use when waiting for socket activities. timeout value to use when waiting for socket activities.
4. Add easy handles 4. Add easy handles with curl_multi_add_handle()
5. Call curl_multi_socket_all() first once 5. Provide some means to manage the sockets libcurl is using, so you can check
6. Provide some means to manage the sockets libcurl is using, so you can check
them for activity. This can be done through your application code, or by way them for activity. This can be done through your application code, or by way
of an external library such as libevent or glib. of an external library such as libevent or glib.
7. Wait for activity on any of libcurl's sockets, use the timeout value your 6. Wait for activity on any of libcurl's sockets, use the timeout value your
callback has been told callback has been told
8, When activity is detected, call curl_multi_socket_action() for the 7, When activity is detected, call curl_multi_socket_action() for the
socket(s) that got action. If no activity is detected and the timeout expires, socket(s) that got action. If no activity is detected and the timeout expires,
call \fIcurl_multi_socket(3)\fP with \fICURL_SOCKET_TIMEOUT\fP call \fIcurl_multi_socket_action(3)\fP with \fICURL_SOCKET_TIMEOUT\fP
9. Go back to step 7. 8. Go back to step 6.
.SH AVAILABILITY .SH AVAILABILITY
This function was added in libcurl 7.15.4, although deemed stable since This function was added in libcurl 7.15.4, although deemed stable since
7.16.0. 7.16.0.