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