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 bool 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(size_t hashsize, 49 size_t chashsize, 50 size_t dnssize, 51 size_t sesssize); 52 53 /* the write bits start at bit 16 for the *getsock() bitmap */ 54 #define GETSOCK_WRITEBITSTART 16 55 56 #define GETSOCK_BLANK 0 /* no bits set */ 57 58 /* set the bit for the given sock number to make the bitmap for writable */ 59 #define GETSOCK_WRITESOCK(x) (1 << (GETSOCK_WRITEBITSTART + (x))) 60 61 /* set the bit for the given sock number to make the bitmap for readable */ 62 #define GETSOCK_READSOCK(x) (1 << (x)) 63 64 /* mask for checking if read and/or write is set for index x */ 65 #define GETSOCK_MASK_RW(x) (GETSOCK_READSOCK(x)|GETSOCK_WRITESOCK(x)) 66 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 is about to be 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 77 void Curl_multi_closed(struct Curl_easy *data, curl_socket_t s); 78 79 /* Compare the two pollsets to notify the multi_socket API of changes 80 * in socket polling, e.g calling multi->socket_cb() with the changes if 81 * differences are seen. 82 */ 83 CURLMcode Curl_multi_pollset_ev(struct Curl_multi *multi, 84 struct Curl_easy *data, 85 struct easy_pollset *ps, 86 struct easy_pollset *last_ps); 87 88 /* 89 * Add a handle and move it into PERFORM state at once. For pushed streams. 90 */ 91 CURLMcode Curl_multi_add_perform(struct Curl_multi *multi, 92 struct Curl_easy *data, 93 struct connectdata *conn); 94 95 96 /* Return the value of the CURLMOPT_MAX_CONCURRENT_STREAMS option */ 97 unsigned int Curl_multi_max_concurrent_streams(struct Curl_multi *multi); 98 99 /** 100 * Borrow the transfer buffer from the multi, suitable 101 * for the given transfer `data`. The buffer may only be used in one 102 * multi processing of the easy handle. It MUST be returned to the 103 * multi before it can be borrowed again. 104 * Pointers into the buffer remain only valid as long as it is borrowed. 105 * 106 * @param data the easy handle 107 * @param pbuf on return, the buffer to use or NULL on error 108 * @param pbuflen on return, the size of *pbuf or 0 on error 109 * @return CURLE_OK when buffer is available and is returned. 110 * CURLE_OUT_OF_MEMORy on failure to allocate the buffer, 111 * CURLE_FAILED_INIT if the easy handle is without multi. 112 * CURLE_AGAIN if the buffer is borrowed already. 113 */ 114 CURLcode Curl_multi_xfer_buf_borrow(struct Curl_easy *data, 115 char **pbuf, size_t *pbuflen); 116 /** 117 * Release the borrowed buffer. All references into the buffer become 118 * invalid after this. 119 * @param buf the buffer pointer borrowed for coding error checks. 120 */ 121 void Curl_multi_xfer_buf_release(struct Curl_easy *data, char *buf); 122 123 /** 124 * Borrow the upload buffer from the multi, suitable 125 * for the given transfer `data`. The buffer may only be used in one 126 * multi processing of the easy handle. It MUST be returned to the 127 * multi before it can be borrowed again. 128 * Pointers into the buffer remain only valid as long as it is borrowed. 129 * 130 * @param data the easy handle 131 * @param pbuf on return, the buffer to use or NULL on error 132 * @param pbuflen on return, the size of *pbuf or 0 on error 133 * @return CURLE_OK when buffer is available and is returned. 134 * CURLE_OUT_OF_MEMORy on failure to allocate the buffer, 135 * CURLE_FAILED_INIT if the easy handle is without multi. 136 * CURLE_AGAIN if the buffer is borrowed already. 137 */ 138 CURLcode Curl_multi_xfer_ulbuf_borrow(struct Curl_easy *data, 139 char **pbuf, size_t *pbuflen); 140 141 /** 142 * Release the borrowed upload buffer. All references into the buffer become 143 * invalid after this. 144 * @param buf the upload buffer pointer borrowed for coding error checks. 145 */ 146 void Curl_multi_xfer_ulbuf_release(struct Curl_easy *data, char *buf); 147 148 /** 149 * Borrow the socket scratch buffer from the multi, suitable 150 * for the given transfer `data`. The buffer may only be used for 151 * direct socket I/O operation by one connection at a time and MUST be 152 * returned to the multi before the I/O call returns. 153 * Pointers into the buffer remain only valid as long as it is borrowed. 154 * 155 * @param data the easy handle 156 * @param blen requested length of the buffer 157 * @param pbuf on return, the buffer to use or NULL on error 158 * @return CURLE_OK when buffer is available and is returned. 159 * CURLE_OUT_OF_MEMORy on failure to allocate the buffer, 160 * CURLE_FAILED_INIT if the easy handle is without multi. 161 * CURLE_AGAIN if the buffer is borrowed already. 162 */ 163 CURLcode Curl_multi_xfer_sockbuf_borrow(struct Curl_easy *data, 164 size_t blen, char **pbuf); 165 /** 166 * Release the borrowed buffer. All references into the buffer become 167 * invalid after this. 168 * @param buf the buffer pointer borrowed for coding error checks. 169 */ 170 void Curl_multi_xfer_sockbuf_release(struct Curl_easy *data, char *buf); 171 172 /** 173 * Get the transfer handle for the given id. Returns NULL if not found. 174 */ 175 struct Curl_easy *Curl_multi_get_handle(struct Curl_multi *multi, 176 curl_off_t id); 177 178 #endif /* HEADER_CURL_MULTIIF_H */ 179