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 /* 28 * Prototypes for library-wide functions provided by multi.c 29 */ 30 31 CURLcode Curl_updatesocket(struct Curl_easy *data); 32 void Curl_expire(struct Curl_easy *data, timediff_t milli, expire_id); 33 void Curl_expire_clear(struct Curl_easy *data); 34 void Curl_expire_done(struct Curl_easy *data, expire_id id); 35 CURLMcode Curl_update_timer(struct Curl_multi *multi) WARN_UNUSED_RESULT; 36 void Curl_attach_connection(struct Curl_easy *data, 37 struct connectdata *conn); 38 void Curl_detach_connection(struct Curl_easy *data); 39 bool Curl_multiplex_wanted(const struct Curl_multi *multi); 40 void Curl_set_in_callback(struct Curl_easy *data, bool value); 41 bool Curl_is_in_callback(struct Curl_easy *easy); 42 CURLcode Curl_preconnect(struct Curl_easy *data); 43 44 /* Internal version of curl_multi_init() accepts size parameters for the 45 socket, connection and dns hashes */ 46 struct Curl_multi *Curl_multi_handle(int hashsize, int chashsize, 47 int dnssize); 48 49 /* the write bits start at bit 16 for the *getsock() bitmap */ 50 #define GETSOCK_WRITEBITSTART 16 51 52 #define GETSOCK_BLANK 0 /* no bits set */ 53 54 /* set the bit for the given sock number to make the bitmap for writable */ 55 #define GETSOCK_WRITESOCK(x) (1 << (GETSOCK_WRITEBITSTART + (x))) 56 57 /* set the bit for the given sock number to make the bitmap for readable */ 58 #define GETSOCK_READSOCK(x) (1 << (x)) 59 60 #ifdef DEBUGBUILD 61 /* 62 * Curl_multi_dump is not a stable public function, this is only meant to 63 * allow easier tracking of the internal handle's state and what sockets 64 * they use. Only for research and development DEBUGBUILD enabled builds. 65 */ 66 void Curl_multi_dump(struct Curl_multi *multi); 67 #endif 68 69 /* Return the value of the CURLMOPT_MAX_HOST_CONNECTIONS option */ 70 size_t Curl_multi_max_host_connections(struct Curl_multi *multi); 71 72 /* Return the value of the CURLMOPT_MAX_TOTAL_CONNECTIONS option */ 73 size_t Curl_multi_max_total_connections(struct Curl_multi *multi); 74 75 void Curl_multiuse_state(struct Curl_easy *data, 76 int bundlestate); /* use BUNDLE_* defines */ 77 78 /* 79 * Curl_multi_closed() 80 * 81 * Used by the connect code to tell the multi_socket code that one of the 82 * sockets we were using is about to be closed. This function will then 83 * remove it from the sockethash for this handle to make the multi_socket API 84 * behave properly, especially for the case when libcurl will create another 85 * socket again and it gets the same file descriptor number. 86 */ 87 88 void Curl_multi_closed(struct Curl_easy *data, curl_socket_t s); 89 90 /* 91 * Add a handle and move it into PERFORM state at once. For pushed streams. 92 */ 93 CURLMcode Curl_multi_add_perform(struct Curl_multi *multi, 94 struct Curl_easy *data, 95 struct connectdata *conn); 96 97 98 /* Return the value of the CURLMOPT_MAX_CONCURRENT_STREAMS option */ 99 unsigned int Curl_multi_max_concurrent_streams(struct Curl_multi *multi); 100 101 #endif /* HEADER_CURL_MULTIIF_H */ 102