Debian Codegraph @

deps/curl/docs/libcurl/curl_multi_wakeup.3

raw
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <[email protected]>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .TH curl_multi_wakeup 3 "17 Nov 2019" "libcurl 7.68.0" "libcurl Manual"
23 .SH NAME
24 curl_multi_wakeup - wakes up a sleeping curl_multi_poll call
25 .SH SYNOPSIS
26 #include <curl/curl.h>
27
28 CURLMcode curl_multi_wakeup(CURLM *multi_handle);
29 .ad
30 .SH DESCRIPTION
31 This function can be called from any thread and it wakes up a
32 sleeping \fIcurl_multi_poll(3)\fP call that is currently (or will be)
33 waiting for activity or a timeout.
34
35 If the function is called when there is no \fIcurl_multi_poll(3)\fP call,
36 it will cause the next call to return immediately.
37
38 Calling this function only guarantees to wake up the current (or the next
39 if there is no current) \fIcurl_multi_poll(3)\fP call, which means it is
40 possible that multiple calls to this function will wake up the same waiting
41 operation.
42
43 This function has no effect on \fIcurl_multi_wait(3)\fP calls.
44 .SH RETURN VALUE
45 CURLMcode type, general libcurl multi interface error code.
46 .SH AVAILABILITY
47 Added in 7.68.0
48 .SH EXAMPLE
49 .nf
50 CURL *easy_handle;
51 CURLM *multi_handle;
52
53 /* add the individual easy handle */
54 curl_multi_add_handle(multi_handle, easy_handle);
55
56 /* this is thread 1 */
57 do {
58 CURLMcode mc;
59 int numfds;
60
61 mc = curl_multi_perform(multi_handle, &still_running);
62
63 if(mc == CURLM_OK) {
64 /* wait for activity, timeout or wakeup */
65 mc = curl_multi_poll(multi_handle, NULL, 0, 10000, &numfds);
66 }
67
68 if(time_to_die())
69 exit(1);
70
71 } while(still_running);
72
73 curl_multi_remove_handle(multi_handle, easy_handle);
74
75 /* this is thread 2 */
76
77 if(something makes us decide to stop thread 1) {
78
79 set_something_to_signal_thread_1_to_exit();
80
81 curl_multi_wakeup(multi_handle);
82 }
83
84 .fi
85 .SH "SEE ALSO"
86 .BR curl_multi_poll "(3), " curl_multi_wait "(3)"