Home | History | Annotate | Download | only in lib
      1 #ifndef HEADER_CURL_CONNCACHE_H
      2 #define HEADER_CURL_CONNCACHE_H
      3 /***************************************************************************
      4  *                                  _   _ ____  _
      5  *  Project                     ___| | | |  _ \| |
      6  *                             / __| | | | |_) | |
      7  *                            | (__| |_| |  _ <| |___
      8  *                             \___|\___/|_| \_\_____|
      9  *
     10  * Copyright (C) 2015 - 2017, Daniel Stenberg, <daniel (at) haxx.se>, et al.
     11  * Copyright (C) 2012 - 2014, Linus Nielsen Feltzing, <linus (at) 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 
     32 struct 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_PIPELINING  1
     44 #define BUNDLE_MULTIPLEX   2
     45 
     46 struct connectbundle {
     47   int multiuse;                 /* supports multi-use */
     48   size_t num_connections;       /* Number of connections in the bundle */
     49   struct curl_llist conn_list;  /* The connectdata members of the bundle */
     50 };
     51 
     52 /* returns 1 on error, 0 is fine */
     53 int Curl_conncache_init(struct conncache *, int size);
     54 void Curl_conncache_destroy(struct conncache *connc);
     55 
     56 /* return the correct bundle, to a host or a proxy */
     57 struct connectbundle *Curl_conncache_find_bundle(struct connectdata *conn,
     58                                                  struct conncache *connc);
     59 void Curl_conncache_unlock(struct connectdata *conn);
     60 /* returns number of connections currently held in the connection cache */
     61 size_t Curl_conncache_size(struct Curl_easy *data);
     62 size_t Curl_conncache_bundle_size(struct connectdata *conn);
     63 
     64 bool Curl_conncache_return_conn(struct connectdata *conn);
     65 CURLcode Curl_conncache_add_conn(struct conncache *connc,
     66                                  struct connectdata *conn);
     67 void Curl_conncache_remove_conn(struct connectdata *conn,
     68                                 bool lock);
     69 bool Curl_conncache_foreach(struct Curl_easy *data,
     70                             struct conncache *connc,
     71                             void *param,
     72                             int (*func)(struct connectdata *conn,
     73                                         void *param));
     74 
     75 struct connectdata *
     76 Curl_conncache_find_first_connection(struct conncache *connc);
     77 
     78 struct connectdata *
     79 Curl_conncache_extract_bundle(struct Curl_easy *data,
     80                               struct connectbundle *bundle);
     81 struct connectdata *
     82 Curl_conncache_extract_oldest(struct Curl_easy *data);
     83 void Curl_conncache_close_all_connections(struct conncache *connc);
     84 void Curl_conncache_print(struct conncache *connc);
     85 
     86 #endif /* HEADER_CURL_CONNCACHE_H */
     87