curl_multi_wakeup.3 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, 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.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. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .TH curl_multi_wakeup 3 "17 Nov 2019" "libcurl" "libcurl"
  25. .SH NAME
  26. curl_multi_wakeup - wakes up a sleeping curl_multi_poll call
  27. .SH SYNOPSIS
  28. .nf
  29. #include <curl/curl.h>
  30. CURLMcode curl_multi_wakeup(CURLM *multi_handle);
  31. .fi
  32. .SH DESCRIPTION
  33. This function can be called from any thread and it wakes up a
  34. sleeping \fIcurl_multi_poll(3)\fP call that is currently (or will be)
  35. waiting for activity or a timeout.
  36. If the function is called when there is no \fIcurl_multi_poll(3)\fP call,
  37. it will cause the next call to return immediately.
  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. This function has no effect on \fIcurl_multi_wait(3)\fP calls.
  43. .SH EXAMPLE
  44. .nf
  45. CURL *easy_handle;
  46. CURLM *multi_handle;
  47. /* add the individual easy handle */
  48. curl_multi_add_handle(multi_handle, easy_handle);
  49. /* this is thread 1 */
  50. do {
  51. CURLMcode mc;
  52. int numfds;
  53. mc = curl_multi_perform(multi_handle, &still_running);
  54. if(mc == CURLM_OK) {
  55. /* wait for activity, timeout or wakeup */
  56. mc = curl_multi_poll(multi_handle, NULL, 0, 10000, &numfds);
  57. }
  58. if(time_to_die())
  59. exit(1);
  60. } while(still_running);
  61. curl_multi_remove_handle(multi_handle, easy_handle);
  62. /* this is thread 2 */
  63. if(something makes us decide to stop thread 1) {
  64. set_something_to_signal_thread_1_to_exit();
  65. curl_multi_wakeup(multi_handle);
  66. }
  67. .fi
  68. .SH AVAILABILITY
  69. Added in 7.68.0
  70. .SH RETURN VALUE
  71. CURLMcode type, general libcurl multi interface error code.
  72. .SH "SEE ALSO"
  73. .BR curl_multi_poll "(3), " curl_multi_wait "(3)"