include/curl/multi.h

   1 #ifndef __CURL_MULTI_H
   2 #define __CURL_MULTI_H
   3 /***************************************************************************
   4  *                                  _   _ ____  _
   5  *  Project                     ___| | | |  _ \| |
   6  *                             / __| | | | |_) | |
   7  *                            | (__| |_| |  _ <| |___
   8  *                             \___|\___/|_| \_\_____|
   9  *
  10  * Copyright (C) 1998 - 2005, 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  * $Id$
  24  ***************************************************************************/
  25 /*
  26   This is an "external" header file. Don't give away any internals here!
  27
  28   GOALS
  29
  30   o Enable a "pull" interface. The application that uses libcurl decides where
  31     and when to ask libcurl to get/send data.
  32
  33   o Enable multiple simultaneous transfers in the same thread without making it
  34     complicated for the application.
  35
  36   o Enable the application to select() on its own file descriptors and curl's
  37     file descriptors simultaneous easily.
  38
  39 */
  40 #if defined(_WIN32) && !defined(WIN32)
  41 /* Chris Lewis mentioned that he doesn't get WIN32 defined, only _WIN32 so we
  42    make this adjustment to catch this. */
  43 #define WIN32 1
  44 #endif
  45
  46 #if defined(WIN32) && !defined(_WIN32_WCE) && !defined(__GNUC__) || \
  47   defined(__MINGW32__)
  48 #if !(defined(_WINSOCKAPI_) || defined(_WINSOCK_H))
  49 /* The check above prevents the winsock2 inclusion if winsock.h already was
  50    included, since they can't co-exist without problems */
  51 #include <winsock2.h>
  52 #endif
  53 #else
  54
  55 /* HP-UX systems version 9, 10 and 11 lack sys/select.h and so does oldish
  56    libc5-based Linux systems. Only include it on system that are known to
  57    require it! */
  58 #if defined(_AIX) || defined(NETWARE)
  59 #include <sys/select.h>
  60 #endif
  61
  62 #ifndef _WIN32_WCE
  63 #include <sys/socket.h>
  64 #endif
  65 #include <sys/time.h>
  66 #include <sys/types.h>
  67 #endif
  68
  69 #include "curl.h"
  70
  71 #ifdef  __cplusplus
  72 extern "C" {
  73 #endif
  74
  75 typedef void CURLM;
  76
  77 #ifdef HAVE_CURL_MULTI_SOCKET /* this is not set by anything yet */
  78
  79 #ifndef curl_socket_typedef
  80 /* Public socket typedef */
  81 #ifdef WIN32
  82 typedef SOCKET curl_socket_t;
  83 #define CURL_SOCKET_BAD INVALID_SOCKET
  84 #else
  85 typedef int curl_socket_t;
  86 #define CURL_SOCKET_BAD -1
  87 #endif
  88 #define curl_socket_typedef
  89 #endif /* curl_socket_typedef */
  90
  91 #endif /* HAVE_CURL_MULTI_SOCKET */
  92
  93 typedef enum {
  94   CURLM_CALL_MULTI_PERFORM=-1, /* please call curl_multi_perform() soon */
  95   CURLM_OK,
  96   CURLM_BAD_HANDLE,      /* the passed-in handle is not a valid CURLM handle */
  97   CURLM_BAD_EASY_HANDLE, /* an easy handle was not good/valid */
  98   CURLM_OUT_OF_MEMORY,   /* if you ever get this, you're in deep sh*t */
  99   CURLM_INTERNAL_ERROR,  /* this is a libcurl bug */
 100   CURLM_LAST
 101 } CURLMcode;
 102
 103 typedef enum {
 104   CURLMSG_NONE, /* first, not used */
 105   CURLMSG_DONE, /* This easy handle has completed. 'result' contains
 106                    the CURLcode of the transfer */
 107   CURLMSG_LAST /* last, not used */
 108 } CURLMSG;
 109
 110 struct CURLMsg {
 111   CURLMSG msg;       /* what this message means */
 112   CURL *easy_handle; /* the handle it concerns */
 113   union {
 114     void *whatever;    /* message-specific data */
 115     CURLcode result;   /* return code for transfer */
 116   } data;
 117 };
 118 typedef struct CURLMsg CURLMsg;
 119
 120 /*
 121  * Name:    curl_multi_init()
 122  *
 123  * Desc:    inititalize multi-style curl usage
 124  *
 125  * Returns: a new CURLM handle to use in all 'curl_multi' functions.
 126  */
 127 CURL_EXTERN CURLM *curl_multi_init(void);
 128
 129 /*
 130  * Name:    curl_multi_add_handle()
 131  *
 132  * Desc:    add a standard curl handle to the multi stack
 133  *
 134  * Returns: CURLMcode type, general multi error code.
 135  */
 136 CURL_EXTERN CURLMcode curl_multi_add_handle(CURLM *multi_handle,
 137                                             CURL *curl_handle);
 138
 139  /*
 140   * Name:    curl_multi_remove_handle()
 141   *
 142   * Desc:    removes a curl handle from the multi stack again
 143   *
 144   * Returns: CURLMcode type, general multi error code.
 145   */
 146 CURL_EXTERN CURLMcode curl_multi_remove_handle(CURLM *multi_handle,
 147                                                CURL *curl_handle);
 148
 149  /*
 150   * Name:    curl_multi_fdset()
 151   *
 152   * Desc:    Ask curl for its fd_set sets. The app can use these to select() or
 153   *          poll() on. We want curl_multi_perform() called as soon as one of
 154   *          them are ready.
 155   *
 156   * Returns: CURLMcode type, general multi error code.
 157   */
 158 CURL_EXTERN CURLMcode curl_multi_fdset(CURLM *multi_handle,
 159                                        fd_set *read_fd_set,
 160                                        fd_set *write_fd_set,
 161                                        fd_set *exc_fd_set,
 162                                        int *max_fd);
 163
 164  /*
 165   * Name:    curl_multi_perform()
 166   *
 167   * Desc:    When the app thinks there's data available for curl it calls this
 168   *          function to read/write whatever there is right now. This returns
 169   *          as soon as the reads and writes are done. This function does not
 170   *          require that there actually is data available for reading or that
 171   *          data can be written, it can be called just in case. It returns
 172   *          the number of handles that still transfer data in the second
 173   *          argument's integer-pointer.
 174   *
 175   * Returns: CURLMcode type, general multi error code. *NOTE* that this only
 176   *          returns errors etc regarding the whole multi stack. There might
 177   *          still have occurred problems on invidual transfers even when this
 178   *          returns OK.
 179   */
 180 CURL_EXTERN CURLMcode curl_multi_perform(CURLM *multi_handle,
 181                                          int *running_handles);
 182
 183  /*
 184   * Name:    curl_multi_cleanup()
 185   *
 186   * Desc:    Cleans up and removes a whole multi stack. It does not free or
 187   *          touch any individual easy handles in any way. We need to define
 188   *          in what state those handles will be if this function is called
 189   *          in the middle of a transfer.
 190   *
 191   * Returns: CURLMcode type, general multi error code.
 192   */
 193 CURL_EXTERN CURLMcode curl_multi_cleanup(CURLM *multi_handle);
 194
 195 /*
 196  * Name:    curl_multi_info_read()
 197  *
 198  * Desc:    Ask the multi handle if there's any messages/informationals from
 199  *          the individual transfers. Messages include informationals such as
 200  *          error code from the transfer or just the fact that a transfer is
 201  *          completed. More details on these should be written down as well.
 202  *
 203  *          Repeated calls to this function will return a new struct each
 204  *          time, until a special "end of msgs" struct is returned as a signal
 205  *          that there is no more to get at this point.
 206  *
 207  *          The data the returned pointer points to will not survive calling
 208  *          curl_multi_cleanup().
 209  *
 210  *          The 'CURLMsg' struct is meant to be very simple and only contain
 211  *          very basic informations. If more involved information is wanted,
 212  *          we will provide the particular "transfer handle" in that struct
 213  *          and that should/could/would be used in subsequent
 214  *          curl_easy_getinfo() calls (or similar). The point being that we
 215  *          must never expose complex structs to applications, as then we'll
 216  *          undoubtably get backwards compatibility problems in the future.
 217  *
 218  * Returns: A pointer to a filled-in struct, or NULL if it failed or ran out
 219  *          of structs. It also writes the number of messages left in the
 220  *          queue (after this read) in the integer the second argument points
 221  *          to.
 222  */
 223 CURL_EXTERN CURLMsg *curl_multi_info_read(CURLM *multi_handle,
 224                                           int *msgs_in_queue);
 225
 226 /*
 227  * Name:    curl_multi_strerror()
 228  *
 229  * Desc:    The curl_multi_strerror function may be used to turn a CURLMcode
 230  *          value into the equivalent human readable error string.  This is
 231  *          useful for printing meaningful error messages.
 232  *
 233  * Returns: A pointer to a zero-terminated error message.
 234  */
 235 CURL_EXTERN const char *curl_multi_strerror(CURLMcode);
 236
 237 #ifdef HAVE_CURL_MULTI_SOCKET
 238 /*
 239  * Name:    curl_multi_socket() and
 240  *          curl_multi_socket_all()
 241  *
 242  * Desc:    An alternative version of curl_multi_perform() that allows the
 243  *          application to pass in one of the file descriptors that have been
 244  *          detected to have "action" on them and let libcurl perform. This
 245  *          allows libcurl to not have to scan through all possible file
 246  *          descriptors to check for this. The app is recommended to pass in
 247  *          the 'easy' argument (or set it to CURL_EASY_NONE) to make libcurl
 248  *          figure out the internal structure even faster and easier.  If the
 249  *          easy argument is set to something else than CURL_EASY_NONE, the
 250  *          's' (socket) argument will be ignored by libcurl.
 251  *
 252  *          It also informs the application about updates in the socket (file
 253  *          descriptor) status by doing none, one or multiple calls to the
 254  *          curl_socket_callback. It thus updates the status with changes
 255  *          since the previous time this function was used. If 'callback' is
 256  *          NULL, no callback will be called. A status change may also be a
 257  *          new timeout only, having the same IN/OUT status as before.
 258  *
 259  *          If a previous wait for socket action(s) timed out, you should call
 260  *          this function with the socket argument set to
 261  *          CURL_SOCKET_TIMEOUT. If you want to force libcurl to (re-)check
 262  *          all its internal sockets, and call the callback with status for
 263  *          all sockets no matter what the previous state is, you call
 264  *          curl_multi_socket_all() instead.
 265  *
 266  *          curl_multi_perform() is thus the equivalent of calling
 267  *          curl_multi_socket_all(handle, NULL, NULL);
 268  *
 269  *          IMPLEMENTATION: libcurl will need an internal hash table to map
 270  *          socket numbers to internal easy handles for the cases when 'easy'
 271  *          is set to CURL_EASY_NONE.
 272  *
 273  *          Regarding the timeout argument in the callback: it is the timeout
 274  *          (in milliseconds) for waiting on action on this socket (and the
 275  *          given time period starts when the callback is called) until you
 276  *          should call curl_multi_socket() with the timeout stuff mentioned
 277  *          above. If "actions" happens on the socket before the timeout
 278  *          happens, remember that the timout timer keeps ticking until told
 279  *          otherwise.
 280  *
 281  *          The "what" argument has one of five values:
 282  *
 283  *            0 CURL_POLL_NONE (0)   - register, not interested in readiness
 284  *            1 CURL_POLL_IN         - register, interested in read readiness
 285  *            2 CURL_POLL_OUT        - register, interested in write readiness
 286  *            3 CURL_POLL_INOUT      - register, interested in both
 287  *            4 CURL_POLL_REMOVE     - deregister
 288  */
 289 #define CURL_POLL_NONE   0
 290 #define CURL_POLL_IN     1
 291 #define CURL_POLL_OUT    2
 292 #define CURL_POLL_INOUT  3
 293 #define CURL_POLL_REMOVE 4
 294
 295 #define CURL_EASY_NONE (CURL *)0
 296 #define CURL_EASY_TIMEOUT (CURL *)0
 297 #define CURL_SOCKET_TIMEOUT CURL_SOCKET_BAD
 298
 299 typedef int (*curl_socket_callback)(CURL *easy,      /* easy handle */
 300                                     curl_socket_t s, /* socket */
 301                                     int what,        /* see above */
 302                                     long ms,         /* timeout for wait */
 303                                     void *userp);    /* "private" pointer */
 304
 305 CURLMcode curl_multi_socket(CURLM *multi_handle,
 306                             curl_socket_t s,
 307                             CURL *easy,
 308                             curl_socket_callback callback,
 309                             void *userp); /* passed to callback */
 310
 311 CURLMcode curl_multi_socket_all(CURLM *multi_handle,
 312                                 curl_socket_callback callback,
 313                                 void *userp); /* passed to callback */
 314
 315 /*
 316  * Name:    curl_multi_timeout()
 317  *
 318  * Desc:    Returns the maximum number of milliseconds the app is allowed to
 319  *          wait before curl_multi_socket() or curl_multi_perform() must be
 320  *          called (to allow libcurl's timed events to take place).
 321  *
 322  * Returns: CURLM error code.
 323  */
 324 CURLMcode curl_multi_timeout(CURLM *multi_handle, long *milliseconds);
 325
 326 #endif /* HAVE_CURL_MULTI_SOCKET */
 327
 328 #ifdef __cplusplus
 329 } /* end of extern "C" */
 330 #endif
 331
 332 #endif