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