multihandle.h 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  1. #ifndef HEADER_CURL_MULTIHANDLE_H
  2. #define HEADER_CURL_MULTIHANDLE_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 1998 - 2015, Daniel Stenberg, <[email protected]>, 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.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. #include "conncache.h"
  25. struct Curl_message {
  26. /* the 'CURLMsg' is the part that is visible to the external user */
  27. struct CURLMsg extmsg;
  28. };
  29. /* NOTE: if you add a state here, add the name to the statename[] array as
  30. well!
  31. */
  32. typedef enum {
  33. CURLM_STATE_INIT, /* 0 - start in this state */
  34. CURLM_STATE_CONNECT_PEND, /* 1 - no connections, waiting for one */
  35. CURLM_STATE_CONNECT, /* 2 - resolve/connect has been sent off */
  36. CURLM_STATE_WAITRESOLVE, /* 3 - awaiting the resolve to finalize */
  37. CURLM_STATE_WAITCONNECT, /* 4 - awaiting the TCP connect to finalize */
  38. CURLM_STATE_WAITPROXYCONNECT, /* 5 - awaiting HTTPS proxy SSL initialization
  39. to complete and/or proxy CONNECT to
  40. finalize */
  41. CURLM_STATE_SENDPROTOCONNECT, /* 6 - initiate protocol connect procedure */
  42. CURLM_STATE_PROTOCONNECT, /* 7 - completing the protocol-specific connect
  43. phase */
  44. CURLM_STATE_WAITDO, /* 8 - wait for our turn to send the request */
  45. CURLM_STATE_DO, /* 9 - start send off the request (part 1) */
  46. CURLM_STATE_DOING, /* 10 - sending off the request (part 1) */
  47. CURLM_STATE_DO_MORE, /* 11 - send off the request (part 2) */
  48. CURLM_STATE_DO_DONE, /* 12 - done sending off request */
  49. CURLM_STATE_WAITPERFORM, /* 13 - wait for our turn to read the response */
  50. CURLM_STATE_PERFORM, /* 14 - transfer data */
  51. CURLM_STATE_TOOFAST, /* 15 - wait because limit-rate exceeded */
  52. CURLM_STATE_DONE, /* 16 - post data transfer operation */
  53. CURLM_STATE_COMPLETED, /* 17 - operation complete */
  54. CURLM_STATE_MSGSENT, /* 18 - the operation complete message is sent */
  55. CURLM_STATE_LAST /* 19 - not a true state, never use this */
  56. } CURLMstate;
  57. /* we support N sockets per easy handle. Set the corresponding bit to what
  58. action we should wait for */
  59. #define MAX_SOCKSPEREASYHANDLE 5
  60. #define GETSOCK_READABLE (0x00ff)
  61. #define GETSOCK_WRITABLE (0xff00)
  62. #define CURLPIPE_ANY (CURLPIPE_HTTP1 | CURLPIPE_MULTIPLEX)
  63. /* This is the struct known as CURLM on the outside */
  64. struct Curl_multi {
  65. /* First a simple identifier to easier detect if a user mix up
  66. this multi handle with an easy handle. Set this to CURL_MULTI_HANDLE. */
  67. long type;
  68. /* We have a doubly-linked circular list with easy handles */
  69. struct Curl_easy *easyp;
  70. struct Curl_easy *easylp; /* last node */
  71. int num_easy; /* amount of entries in the linked list above. */
  72. int num_alive; /* amount of easy handles that are added but have not yet
  73. reached COMPLETE state */
  74. struct curl_llist *msglist; /* a list of messages from completed transfers */
  75. struct curl_llist *pending; /* Curl_easys that are in the
  76. CURLM_STATE_CONNECT_PEND state */
  77. /* callback function and user data pointer for the *socket() API */
  78. curl_socket_callback socket_cb;
  79. void *socket_userp;
  80. /* callback function and user data pointer for server push */
  81. curl_push_callback push_cb;
  82. void *push_userp;
  83. /* Hostname cache */
  84. struct curl_hash hostcache;
  85. /* timetree points to the splay-tree of time nodes to figure out expire
  86. times of all currently set timers */
  87. struct Curl_tree *timetree;
  88. /* 'sockhash' is the lookup hash for socket descriptor => easy handles (note
  89. the pluralis form, there can be more than one easy handle waiting on the
  90. same actual socket) */
  91. struct curl_hash sockhash;
  92. /* pipelining wanted bits (CURLPIPE*) */
  93. long pipelining;
  94. bool recheckstate; /* see Curl_multi_connchanged */
  95. /* Shared connection cache (bundles)*/
  96. struct conncache conn_cache;
  97. /* This handle will be used for closing the cached connections in
  98. curl_multi_cleanup() */
  99. struct Curl_easy *closure_handle;
  100. long maxconnects; /* if >0, a fixed limit of the maximum number of entries
  101. we're allowed to grow the connection cache to */
  102. long max_host_connections; /* if >0, a fixed limit of the maximum number
  103. of connections per host */
  104. long max_total_connections; /* if >0, a fixed limit of the maximum number
  105. of connections in total */
  106. long max_pipeline_length; /* if >0, maximum number of requests in a
  107. pipeline */
  108. long content_length_penalty_size; /* a connection with a
  109. content-length bigger than
  110. this is not considered
  111. for pipelining */
  112. long chunk_length_penalty_size; /* a connection with a chunk length
  113. bigger than this is not
  114. considered for pipelining */
  115. struct curl_llist *pipelining_site_bl; /* List of sites that are blacklisted
  116. from pipelining */
  117. struct curl_llist *pipelining_server_bl; /* List of server types that are
  118. blacklisted from pipelining */
  119. /* timer callback and user data pointer for the *socket() API */
  120. curl_multi_timer_callback timer_cb;
  121. void *timer_userp;
  122. struct timeval timer_lastcall; /* the fixed time for the timeout for the
  123. previous callback */
  124. };
  125. #endif /* HEADER_CURL_MULTIHANDLE_H */