diff options
| author | Gergely Nagy <ngg@tresorit.com> | 2019-11-17 15:12:15 +0100 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2019-11-25 15:45:56 +0100 |
| commit | f3c35e371cc70f1b6bc33f7faa904d37d1567eb3 (patch) | |
| tree | 3c7668dec5726aa510d7be282ff440c9ee370802 /docs/libcurl/curl_multi_poll.3 | |
| parent | 0a65febccf0e31bc987be3f90c01194804e61b77 (diff) | |
multi: add curl_multi_wakeup()
This commit adds curl_multi_wakeup() which was previously in the TODO
list under the curl_multi_unblock name.
On some platforms and with some configurations this feature might not be
available or can fail, in these cases a new error code
(CURLM_WAKEUP_FAILURE) is returned from curl_multi_wakeup().
Fixes #4418
Closes #4608
Diffstat (limited to 'docs/libcurl/curl_multi_poll.3')
| -rw-r--r-- | docs/libcurl/curl_multi_poll.3 | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/libcurl/curl_multi_poll.3 b/docs/libcurl/curl_multi_poll.3 index 9fc72c55d..bde80447a 100644 --- a/docs/libcurl/curl_multi_poll.3 +++ b/docs/libcurl/curl_multi_poll.3 @@ -48,10 +48,16 @@ total number of file descriptors on which interesting events occurred. This number can include both libcurl internal descriptors as well as descriptors provided in \fIextra_fds\fP. +The \fIcurl_multi_wakeup(3)\fP function can be used from another thread to +wake up this function and return faster. This is one of the details +that makes this function different than \fIcurl_multi_wait(3)\fP which cannot +be woken up this way. + If no extra file descriptors are provided and libcurl has no file descriptor to offer to wait for, this function will instead wait during \fItimeout_ms\fP milliseconds (or shorter if an internal timer indicates so). This is the -detail that makes this function different than \fIcurl_multi_wait(3)\fP. +other detail that makes this function different than +\fIcurl_multi_wait(3)\fP. 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 @@ -107,4 +113,5 @@ CURLMcode type, general libcurl multi interface error code. See .SH AVAILABILITY This function was added in libcurl 7.66.0. .SH "SEE ALSO" -.BR curl_multi_fdset "(3), " curl_multi_perform "(3), " curl_multi_wait "(3)" +.BR curl_multi_fdset "(3), " curl_multi_perform "(3), " +.BR curl_multi_wait "(3), " curl_multi_wakeup "(3)" |