multiif.h 4.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. #ifndef HEADER_CURL_MULTIIF_H
  2. #define HEADER_CURL_MULTIIF_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 1998 - 2014, 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 http://curl.haxx.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. ***************************************************************************/
  24. /*
  25. * Prototypes for library-wide functions provided by multi.c
  26. */
  27. void Curl_expire(struct SessionHandle *data, long milli);
  28. void Curl_expire_latest(struct SessionHandle *data, long milli);
  29. bool Curl_multi_pipeline_enabled(const struct Curl_multi* multi);
  30. void Curl_multi_handlePipeBreak(struct SessionHandle *data);
  31. /* Internal version of curl_multi_init() accepts size parameters for the
  32. socket and connection hashes */
  33. struct Curl_multi *Curl_multi_handle(int hashsize, int chashsize);
  34. /* the write bits start at bit 16 for the *getsock() bitmap */
  35. #define GETSOCK_WRITEBITSTART 16
  36. #define GETSOCK_BLANK 0 /* no bits set */
  37. /* set the bit for the given sock number to make the bitmap for writable */
  38. #define GETSOCK_WRITESOCK(x) (1 << (GETSOCK_WRITEBITSTART + (x)))
  39. /* set the bit for the given sock number to make the bitmap for readable */
  40. #define GETSOCK_READSOCK(x) (1 << (x))
  41. #ifdef DEBUGBUILD
  42. /*
  43. * Curl_multi_dump is not a stable public function, this is only meant to
  44. * allow easier tracking of the internal handle's state and what sockets
  45. * they use. Only for research and development DEBUGBUILD enabled builds.
  46. */
  47. void Curl_multi_dump(const struct Curl_multi *multi_handle);
  48. #endif
  49. /* Update the current connection of a One_Easy handle */
  50. void Curl_multi_set_easy_connection(struct SessionHandle *handle,
  51. struct connectdata *conn);
  52. void Curl_multi_process_pending_handles(struct Curl_multi *multi);
  53. /* Return the value of the CURLMOPT_MAX_HOST_CONNECTIONS option */
  54. size_t Curl_multi_max_host_connections(struct Curl_multi *multi);
  55. /* Return the value of the CURLMOPT_MAX_PIPELINE_LENGTH option */
  56. size_t Curl_multi_max_pipeline_length(struct Curl_multi *multi);
  57. /* Return the value of the CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE option */
  58. curl_off_t Curl_multi_content_length_penalty_size(struct Curl_multi *multi);
  59. /* Return the value of the CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE option */
  60. curl_off_t Curl_multi_chunk_length_penalty_size(struct Curl_multi *multi);
  61. /* Return the value of the CURLMOPT_PIPELINING_SITE_BL option */
  62. struct curl_llist *Curl_multi_pipelining_site_bl(struct Curl_multi *multi);
  63. /* Return the value of the CURLMOPT_PIPELINING_SERVER_BL option */
  64. struct curl_llist *Curl_multi_pipelining_server_bl(struct Curl_multi *multi);
  65. /* Return the value of the CURLMOPT_MAX_TOTAL_CONNECTIONS option */
  66. size_t Curl_multi_max_total_connections(struct Curl_multi *multi);
  67. /*
  68. * Curl_multi_closed()
  69. *
  70. * Used by the connect code to tell the multi_socket code that one of the
  71. * sockets we were using have just been closed. This function will then
  72. * remove it from the sockethash for this handle to make the multi_socket API
  73. * behave properly, especially for the case when libcurl will create another
  74. * socket again and it gets the same file descriptor number.
  75. */
  76. void Curl_multi_closed(struct connectdata *conn, curl_socket_t s);
  77. #endif /* HEADER_CURL_MULTIIF_H */