multiif.h 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. #ifndef HEADER_CURL_MULTIIF_H
  2. #define HEADER_CURL_MULTIIF_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
  11. *
  12. * This software is licensed as described in the file COPYING, which
  13. * you should have received as part of this distribution. The terms
  14. * are also available at https://curl.se/docs/copyright.html.
  15. *
  16. * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  17. * copies of the Software, and permit persons to whom the Software is
  18. * furnished to do so, under the terms of the COPYING file.
  19. *
  20. * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21. * KIND, either express or implied.
  22. *
  23. * SPDX-License-Identifier: curl
  24. *
  25. ***************************************************************************/
  26. /*
  27. * Prototypes for library-wide functions provided by multi.c
  28. */
  29. CURLcode Curl_updatesocket(struct Curl_easy *data);
  30. void Curl_expire(struct Curl_easy *data, timediff_t milli, expire_id);
  31. void Curl_expire_clear(struct Curl_easy *data);
  32. void Curl_expire_done(struct Curl_easy *data, expire_id id);
  33. CURLMcode Curl_update_timer(struct Curl_multi *multi) WARN_UNUSED_RESULT;
  34. void Curl_attach_connection(struct Curl_easy *data,
  35. struct connectdata *conn);
  36. void Curl_detach_connection(struct Curl_easy *data);
  37. bool Curl_multiplex_wanted(const struct Curl_multi *multi);
  38. void Curl_set_in_callback(struct Curl_easy *data, bool value);
  39. bool Curl_is_in_callback(struct Curl_easy *easy);
  40. CURLcode Curl_preconnect(struct Curl_easy *data);
  41. /* Internal version of curl_multi_init() accepts size parameters for the
  42. socket, connection and dns hashes */
  43. struct Curl_multi *Curl_multi_handle(int hashsize, int chashsize,
  44. int dnssize);
  45. /* the write bits start at bit 16 for the *getsock() bitmap */
  46. #define GETSOCK_WRITEBITSTART 16
  47. #define GETSOCK_BLANK 0 /* no bits set */
  48. /* set the bit for the given sock number to make the bitmap for writable */
  49. #define GETSOCK_WRITESOCK(x) (1 << (GETSOCK_WRITEBITSTART + (x)))
  50. /* set the bit for the given sock number to make the bitmap for readable */
  51. #define GETSOCK_READSOCK(x) (1 << (x))
  52. #ifdef DEBUGBUILD
  53. /*
  54. * Curl_multi_dump is not a stable public function, this is only meant to
  55. * allow easier tracking of the internal handle's state and what sockets
  56. * they use. Only for research and development DEBUGBUILD enabled builds.
  57. */
  58. void Curl_multi_dump(struct Curl_multi *multi);
  59. #endif
  60. /* Return the value of the CURLMOPT_MAX_HOST_CONNECTIONS option */
  61. size_t Curl_multi_max_host_connections(struct Curl_multi *multi);
  62. /* Return the value of the CURLMOPT_MAX_TOTAL_CONNECTIONS option */
  63. size_t Curl_multi_max_total_connections(struct Curl_multi *multi);
  64. void Curl_multiuse_state(struct Curl_easy *data,
  65. int bundlestate); /* use BUNDLE_* defines */
  66. /*
  67. * Curl_multi_closed()
  68. *
  69. * Used by the connect code to tell the multi_socket code that one of the
  70. * sockets we were using is about to be closed. This function will then
  71. * remove it from the sockethash for this handle to make the multi_socket API
  72. * behave properly, especially for the case when libcurl will create another
  73. * socket again and it gets the same file descriptor number.
  74. */
  75. void Curl_multi_closed(struct Curl_easy *data, curl_socket_t s);
  76. /*
  77. * Add a handle and move it into PERFORM state at once. For pushed streams.
  78. */
  79. CURLMcode Curl_multi_add_perform(struct Curl_multi *multi,
  80. struct Curl_easy *data,
  81. struct connectdata *conn);
  82. /* Return the value of the CURLMOPT_MAX_CONCURRENT_STREAMS option */
  83. unsigned int Curl_multi_max_concurrent_streams(struct Curl_multi *multi);
  84. #endif /* HEADER_CURL_MULTIIF_H */