diff options
Diffstat (limited to 'docs/libcurl/curl_multi_wakeup.3')
| -rw-r--r-- | docs/libcurl/curl_multi_wakeup.3 | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/libcurl/curl_multi_wakeup.3 b/docs/libcurl/curl_multi_wakeup.3 new file mode 100644 index 000000000..01b462f2f --- /dev/null +++ b/docs/libcurl/curl_multi_wakeup.3 @@ -0,0 +1,47 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2019, 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 https://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_wakeup 3 "17 Nov 2019" "libcurl 7.68.0" "libcurl Manual" +.SH NAME +curl_multi_wakeup - wakes up a sleeping curl_multi_poll call +.SH SYNOPSIS +#include <curl/curl.h> + +CURLMcode curl_multi_wakeup(CURLM *multi_handle); +.ad +.SH DESCRIPTION +This function can be called from any thread and it wakes up a +sleeping \fIcurl_multi_poll(3)\fP call that is currently (or will be) +waiting for activity or a timeout. + +If the function is called when there is no \fIcurl_multi_poll(3)\fP call, +it will cause the next call to return immediately. + +Calling this function only guarantees to wake up the current (or the next +if there is no current) \fIcurl_multi_poll(3)\fP call, which means it is +possible that multiple calls to this function will wake up the same waiting +operation. + +This function has no effect on \fIcurl_multi_wait(3)\fP calls. +.SH RETURN VALUE +CURLMcode type, general libcurl multi interface error code. +.SH "SEE ALSO" +.BR curl_multi_poll "(3), " curl_multi_wait "(3)" |