1#ifndef HEADER_CURL_CONNCACHE_H
2#define HEADER_CURL_CONNCACHE_H
3/***************************************************************************
4 * _ _ ____ _
5 * Project ___| | | | _ \| |
6 * / __| | | | |_) | |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
9 *
10 * Copyright (C) 2015 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
11 * Copyright (C) 2012 - 2014, Linus Nielsen Feltzing, <linus@haxx.se>
12 *
13 * This software is licensed as described in the file COPYING, which
14 * you should have received as part of this distribution. The terms
15 * are also available at https://curl.haxx.se/docs/copyright.html.
16 *
17 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
18 * copies of the Software, and permit persons to whom the Software is
19 * furnished to do so, under the terms of the COPYING file.
20 *
21 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
22 * KIND, either express or implied.
23 *
24 ***************************************************************************/
25
26/*
27 * All accesses to struct fields and changing of data in the connection cache
28 * and connectbundles must be done with the conncache LOCKED. The cache might
29 * be shared.
30 */
31
32struct conncache {
33 struct curl_hash hash;
34 size_t num_conn;
35 long next_connection_id;
36 struct curltime last_cleanup;
37 /* handle used for closing cached connections */
38 struct Curl_easy *closure_handle;
39};
40
41#define BUNDLE_NO_MULTIUSE -1
42#define BUNDLE_UNKNOWN 0 /* initial value */
43#define BUNDLE_MULTIPLEX 2
44
45struct connectbundle {
46 int multiuse; /* supports multi-use */
47 size_t num_connections; /* Number of connections in the bundle */
48 struct curl_llist conn_list; /* The connectdata members of the bundle */
49};
50
51/* returns 1 on error, 0 is fine */
52int Curl_conncache_init(struct conncache *, int size);
53void Curl_conncache_destroy(struct conncache *connc);
54
55/* return the correct bundle, to a host or a proxy */
56struct connectbundle *Curl_conncache_find_bundle(struct connectdata *conn,
57 struct conncache *connc,
58 const char **hostp);
59void Curl_conncache_unlock(struct Curl_easy *data);
60/* returns number of connections currently held in the connection cache */
61size_t Curl_conncache_size(struct Curl_easy *data);
62size_t Curl_conncache_bundle_size(struct connectdata *conn);
63
64bool Curl_conncache_return_conn(struct connectdata *conn);
65CURLcode Curl_conncache_add_conn(struct conncache *connc,
66 struct connectdata *conn) WARN_UNUSED_RESULT;
67void Curl_conncache_remove_conn(struct Curl_easy *data,
68 struct connectdata *conn,
69 bool lock);
70bool Curl_conncache_foreach(struct Curl_easy *data,
71 struct conncache *connc,
72 void *param,
73 int (*func)(struct connectdata *conn,
74 void *param));
75
76struct connectdata *
77Curl_conncache_find_first_connection(struct conncache *connc);
78
79struct connectdata *
80Curl_conncache_extract_bundle(struct Curl_easy *data,
81 struct connectbundle *bundle);
82struct connectdata *
83Curl_conncache_extract_oldest(struct Curl_easy *data);
84void Curl_conncache_close_all_connections(struct conncache *connc);
85void Curl_conncache_print(struct conncache *connc);
86
87#endif /* HEADER_CURL_CONNCACHE_H */
88