1#ifndef HEADER_CURL_MULTIIF_H
2#define HEADER_CURL_MULTIIF_H
3/***************************************************************************
4 *                                  _   _ ____  _
5 *  Project                     ___| | | |  _ \| |
6 *                             / __| | | | |_) | |
7 *                            | (__| |_| |  _ <| |___
8 *                             \___|\___/|_| \_\_____|
9 *
10 * Copyright (C) 1998 - 2014, 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 http://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/*
26 * Prototypes for library-wide functions provided by multi.c
27 */
28void Curl_expire(struct SessionHandle *data, long milli);
29
30bool Curl_multi_pipeline_enabled(const struct Curl_multi* multi);
31void Curl_multi_handlePipeBreak(struct SessionHandle *data);
32
33/* Internal version of curl_multi_init() accepts size parameters for the
34   socket and connection hashes */
35struct Curl_multi *Curl_multi_handle(int hashsize, int chashsize);
36
37/* the write bits start at bit 16 for the *getsock() bitmap */
38#define GETSOCK_WRITEBITSTART 16
39
40#define GETSOCK_BLANK 0 /* no bits set */
41
42/* set the bit for the given sock number to make the bitmap for writable */
43#define GETSOCK_WRITESOCK(x) (1 << (GETSOCK_WRITEBITSTART + (x)))
44
45/* set the bit for the given sock number to make the bitmap for readable */
46#define GETSOCK_READSOCK(x) (1 << (x))
47
48#ifdef DEBUGBUILD
49 /*
50  * Curl_multi_dump is not a stable public function, this is only meant to
51  * allow easier tracking of the internal handle's state and what sockets
52  * they use. Only for research and development DEBUGBUILD enabled builds.
53  */
54void Curl_multi_dump(const struct Curl_multi *multi_handle);
55#endif
56
57/* Update the current connection of a One_Easy handle */
58void Curl_multi_set_easy_connection(struct SessionHandle *handle,
59                                    struct connectdata *conn);
60
61void Curl_multi_process_pending_handles(struct Curl_multi *multi);
62
63/* Return the value of the CURLMOPT_MAX_HOST_CONNECTIONS option */
64size_t Curl_multi_max_host_connections(struct Curl_multi *multi);
65
66/* Return the value of the CURLMOPT_MAX_PIPELINE_LENGTH option */
67size_t Curl_multi_max_pipeline_length(struct Curl_multi *multi);
68
69/* Return the value of the CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE option */
70curl_off_t Curl_multi_content_length_penalty_size(struct Curl_multi *multi);
71
72/* Return the value of the CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE option */
73curl_off_t Curl_multi_chunk_length_penalty_size(struct Curl_multi *multi);
74
75/* Return the value of the CURLMOPT_PIPELINING_SITE_BL option */
76struct curl_llist *Curl_multi_pipelining_site_bl(struct Curl_multi *multi);
77
78/* Return the value of the CURLMOPT_PIPELINING_SERVER_BL option */
79struct curl_llist *Curl_multi_pipelining_server_bl(struct Curl_multi *multi);
80
81/* Return the value of the CURLMOPT_MAX_TOTAL_CONNECTIONS option */
82size_t Curl_multi_max_total_connections(struct Curl_multi *multi);
83
84/*
85 * Curl_multi_closed()
86 *
87 * Used by the connect code to tell the multi_socket code that one of the
88 * sockets we were using have just been closed.  This function will then
89 * remove it from the sockethash for this handle to make the multi_socket API
90 * behave properly, especially for the case when libcurl will create another
91 * socket again and it gets the same file descriptor number.
92 */
93
94void Curl_multi_closed(struct connectdata *conn, curl_socket_t s);
95
96#endif /* HEADER_CURL_MULTIIF_H */
97