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