lib/multihandle.h

   1 #ifndef HEADER_CURL_MULTIHANDLE_H
   2 #define HEADER_CURL_MULTIHANDLE_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 struct Curl_message {
  26   /* the 'CURLMsg' is the part that is visible to the external user */
  27   struct CURLMsg extmsg;
  28 };
  29
  30 /* NOTE: if you add a state here, add the name to the statename[] array as
  31    well!
  32 */
  33 typedef enum {
  34   CURLM_STATE_INIT,         /* 0 - start in this state */
  35   CURLM_STATE_CONNECT_PEND, /* 1 - no connections, waiting for one */
  36   CURLM_STATE_CONNECT,      /* 2 - resolve/connect has been sent off */
  37   CURLM_STATE_WAITRESOLVE,  /* 3 - awaiting the resolve to finalize */
  38   CURLM_STATE_WAITCONNECT,  /* 4 - awaiting the connect to finalize */
  39   CURLM_STATE_WAITPROXYCONNECT, /* 5 - awaiting proxy CONNECT to finalize */
  40   CURLM_STATE_PROTOCONNECT, /* 6 - completing the protocol-specific connect
  41                                    phase */
  42   CURLM_STATE_WAITDO,       /* 7 - wait for our turn to send the request */
  43   CURLM_STATE_DO,           /* 8 - start send off the request (part 1) */
  44   CURLM_STATE_DOING,        /* 9 - sending off the request (part 1) */
  45   CURLM_STATE_DO_MORE,      /* 10 - send off the request (part 2) */
  46   CURLM_STATE_DO_DONE,      /* 11 - done sending off request */
  47   CURLM_STATE_WAITPERFORM,  /* 12 - wait for our turn to read the response */
  48   CURLM_STATE_PERFORM,      /* 13 - transfer data */
  49   CURLM_STATE_TOOFAST,      /* 14 - wait because limit-rate exceeded */
  50   CURLM_STATE_DONE,         /* 15 - post data transfer operation */
  51   CURLM_STATE_COMPLETED,    /* 16 - operation complete */
  52   CURLM_STATE_MSGSENT,      /* 17 - the operation complete message is sent */
  53   CURLM_STATE_LAST          /* 18 - not a true state, never use this */
  54 } CURLMstate;
  55
  56 /* we support N sockets per easy handle. Set the corresponding bit to what
  57    action we should wait for */
  58 #define MAX_SOCKSPEREASYHANDLE 5
  59 #define GETSOCK_READABLE (0x00ff)
  60 #define GETSOCK_WRITABLE (0xff00)
  61
  62 /* This is the struct known as CURLM on the outside */
  63 struct Curl_multi {
  64   /* First a simple identifier to easier detect if a user mix up
  65      this multi handle with an easy handle. Set this to CURL_MULTI_HANDLE. */
  66   long type;
  67
  68   /* We have a doubly-linked circular list with easy handles */
  69   struct SessionHandle *easyp;
  70   struct SessionHandle *easylp; /* last node */
  71
  72   int num_easy; /* amount of entries in the linked list above. */
  73   int num_alive; /* amount of easy handles that are added but have not yet
  74                     reached COMPLETE state */
  75
  76   struct curl_llist *msglist; /* a list of messages from completed transfers */
  77
  78   struct curl_llist *pending; /* SessionHandles that are in the
  79                                  CURLM_STATE_CONNECT_PEND state */
  80
  81   /* callback function and user data pointer for the *socket() API */
  82   curl_socket_callback socket_cb;
  83   void *socket_userp;
  84
  85   /* Hostname cache */
  86   struct curl_hash *hostcache;
  87
  88   /* timetree points to the splay-tree of time nodes to figure out expire
  89      times of all currently set timers */
  90   struct Curl_tree *timetree;
  91
  92   /* 'sockhash' is the lookup hash for socket descriptor => easy handles (note
  93      the pluralis form, there can be more than one easy handle waiting on the
  94      same actual socket) */
  95   struct curl_hash *sockhash;
  96
  97   /* Whether pipelining is enabled for this multi handle */
  98   bool pipelining_enabled;
  99
 100   /* Shared connection cache (bundles)*/
 101   struct conncache *conn_cache;
 102
 103   /* This handle will be used for closing the cached connections in
 104      curl_multi_cleanup() */
 105   struct SessionHandle *closure_handle;
 106
 107   long maxconnects; /* if >0, a fixed limit of the maximum number of entries
 108                        we're allowed to grow the connection cache to */
 109
 110   long max_host_connections; /* if >0, a fixed limit of the maximum number
 111                                 of connections per host */
 112
 113   long max_total_connections; /* if >0, a fixed limit of the maximum number
 114                                  of connections in total */
 115
 116   long max_pipeline_length; /* if >0, maximum number of requests in a
 117                                pipeline */
 118
 119   long content_length_penalty_size; /* a connection with a
 120                                        content-length bigger than
 121                                        this is not considered
 122                                        for pipelining */
 123
 124   long chunk_length_penalty_size; /* a connection with a chunk length
 125                                      bigger than this is not
 126                                      considered for pipelining */
 127
 128   struct curl_llist *pipelining_site_bl; /* List of sites that are blacklisted
 129                                             from pipelining */
 130
 131   struct curl_llist *pipelining_server_bl; /* List of server types that are
 132                                               blacklisted from pipelining */
 133
 134   /* timer callback and user data pointer for the *socket() API */
 135   curl_multi_timer_callback timer_cb;
 136   void *timer_userp;
 137   struct timeval timer_lastcall; /* the fixed time for the timeout for the
 138                                     previous callback */
 139 };
 140
 141 #endif /* HEADER_CURL_MULTIHANDLE_H */
 142