multiif.h 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. #ifndef HEADER_CURL_MULTIIF_H
  2. #define HEADER_CURL_MULTIIF_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 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 *data);
  40. CURLcode Curl_preconnect(struct Curl_easy *data);
  41. void Curl_multi_connchanged(struct Curl_multi *multi);
  42. /* Internal version of curl_multi_init() accepts size parameters for the
  43. socket, connection and dns hashes */
  44. struct Curl_multi *Curl_multi_handle(size_t hashsize,
  45. size_t chashsize,
  46. size_t dnssize);
  47. /* the write bits start at bit 16 for the *getsock() bitmap */
  48. #define GETSOCK_WRITEBITSTART 16
  49. #define GETSOCK_BLANK 0 /* no bits set */
  50. /* set the bit for the given sock number to make the bitmap for writable */
  51. #define GETSOCK_WRITESOCK(x) (1 << (GETSOCK_WRITEBITSTART + (x)))
  52. /* set the bit for the given sock number to make the bitmap for readable */
  53. #define GETSOCK_READSOCK(x) (1 << (x))
  54. /* mask for checking if read and/or write is set for index x */
  55. #define GETSOCK_MASK_RW(x) (GETSOCK_READSOCK(x)|GETSOCK_WRITESOCK(x))
  56. /* Return the value of the CURLMOPT_MAX_HOST_CONNECTIONS option */
  57. size_t Curl_multi_max_host_connections(struct Curl_multi *multi);
  58. /* Return the value of the CURLMOPT_MAX_TOTAL_CONNECTIONS option */
  59. size_t Curl_multi_max_total_connections(struct Curl_multi *multi);
  60. void Curl_multiuse_state(struct Curl_easy *data,
  61. int bundlestate); /* use BUNDLE_* defines */
  62. /*
  63. * Curl_multi_closed()
  64. *
  65. * Used by the connect code to tell the multi_socket code that one of the
  66. * sockets we were using is about to be closed. This function will then
  67. * remove it from the sockethash for this handle to make the multi_socket API
  68. * behave properly, especially for the case when libcurl will create another
  69. * socket again and it gets the same file descriptor number.
  70. */
  71. void Curl_multi_closed(struct Curl_easy *data, curl_socket_t s);
  72. /*
  73. * Add a handle and move it into PERFORM state at once. For pushed streams.
  74. */
  75. CURLMcode Curl_multi_add_perform(struct Curl_multi *multi,
  76. struct Curl_easy *data,
  77. struct connectdata *conn);
  78. /* Return the value of the CURLMOPT_MAX_CONCURRENT_STREAMS option */
  79. unsigned int Curl_multi_max_concurrent_streams(struct Curl_multi *multi);
  80. /**
  81. * Borrow the transfer buffer from the multi, suitable
  82. * for the given transfer `data`. The buffer may only be used in one
  83. * multi processing of the easy handle. It MUST be returned to the
  84. * multi before it can be borrowed again.
  85. * Pointers into the buffer remain only valid as long as it is borrowed.
  86. *
  87. * @param data the easy handle
  88. * @param pbuf on return, the buffer to use or NULL on error
  89. * @param pbuflen on return, the size of *pbuf or 0 on error
  90. * @return CURLE_OK when buffer is available and is returned.
  91. * CURLE_OUT_OF_MEMORy on failure to allocate the buffer,
  92. * CURLE_FAILED_INIT if the easy handle is without multi.
  93. * CURLE_AGAIN if the buffer is borrowed already.
  94. */
  95. CURLcode Curl_multi_xfer_buf_borrow(struct Curl_easy *data,
  96. char **pbuf, size_t *pbuflen);
  97. /**
  98. * Release the borrowed buffer. All references into the buffer become
  99. * invalid after this.
  100. * @param buf the buffer pointer borrowed for coding error checks.
  101. */
  102. void Curl_multi_xfer_buf_release(struct Curl_easy *data, char *buf);
  103. /**
  104. * Borrow the upload buffer from the multi, suitable
  105. * for the given transfer `data`. The buffer may only be used in one
  106. * multi processing of the easy handle. It MUST be returned to the
  107. * multi before it can be borrowed again.
  108. * Pointers into the buffer remain only valid as long as it is borrowed.
  109. *
  110. * @param data the easy handle
  111. * @param pbuf on return, the buffer to use or NULL on error
  112. * @param pbuflen on return, the size of *pbuf or 0 on error
  113. * @return CURLE_OK when buffer is available and is returned.
  114. * CURLE_OUT_OF_MEMORy on failure to allocate the buffer,
  115. * CURLE_FAILED_INIT if the easy handle is without multi.
  116. * CURLE_AGAIN if the buffer is borrowed already.
  117. */
  118. CURLcode Curl_multi_xfer_ulbuf_borrow(struct Curl_easy *data,
  119. char **pbuf, size_t *pbuflen);
  120. /**
  121. * Release the borrowed upload buffer. All references into the buffer become
  122. * invalid after this.
  123. * @param buf the upload buffer pointer borrowed for coding error checks.
  124. */
  125. void Curl_multi_xfer_ulbuf_release(struct Curl_easy *data, char *buf);
  126. #endif /* HEADER_CURL_MULTIIF_H */