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